Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-22 15:43:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4188 from quacksouls/doc-stock

Browse Source 
DOC: `stock.getPrice()`: typo fixes and update examples
This commit is contained in:
hydroflame 2022-10-04 11:47:24 -04:00 committed by GitHub
commit 5b699fa19f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -1089,21 +1089,39 @@ export interface TIX {
getSymbols(): string[];
/**
* Returns the price of a stock
* Returns the price of a stock.
*
* @remarks
* RAM cost: 2 GB
* The stock’s price is the average of its bid and ask price.
*
* The stock’s price is the average of its bid and ask prices. This function requires
* that you have the following:
*
* 1. WSE Account
*
* 1. TIX API Access
*
* @example
* ```ts
* // NS1
* stock.getPrice("FISG");
* stock.getPrice("FSIG");
*
* // Choose the first stock symbol from the array of stock symbols. Get the price
* // of the corresponding stock.
* var sym = stock.getSymbols()[0];
* tprint("Stock symbol: " + sym);
* tprint("Stock price: " + stock.getPrice(sym));
* ```
* @example
* ```ts
* // NS2
* ns.stock.getPrice("FISG");
* ns.stock.getPrice("FSIG");
*
* // Choose the first stock symbol from the array of stock symbols. Get the price
* // of the corresponding stock.
* const sym = ns.stock.getSymbols()[0];
* ns.tprint("Stock symbol: " + sym);
* ns.tprint("Stock price: " + ns.stock.getPrice(sym));
* ```
* @param sym - Stock symbol.
* @returns The price of a stock.