mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-26 19:14:32 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
80 lines
1.1 KiB
Markdown
80 lines
1.1 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPrice](./bitburner.tix.getprice.md)
|
||
|
||
## TIX.getPrice() method
|
||
|
||
Returns the price of a stock.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
getPrice(sym: string): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
sym
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
Stock symbol.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
number
|
||
|
||
The price of a stock.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 2 GB
|
||
|
||
The stock’s price is the average of its bid and ask prices. This function requires that you have the following:
|
||
|
||
- WSE Account
|
||
|
||
- TIX API Access
|
||
|
||
## Example
|
||
|
||
|
||
```js
|
||
const fourSigmaStockPrice = 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));
|
||
```
|
||
|