mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-21 16:52:55 +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>
63 lines
1004 B
Markdown
63 lines
1004 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getVolatility](./bitburner.tix.getvolatility.md)
|
||
|
||
## TIX.getVolatility() method
|
||
|
||
Returns the volatility of the specified stock.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
getVolatility(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
|
||
|
||
Volatility of the specified stock.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 2.5 GB Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned in the range 0-1. (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
|
||
|
||
In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.
|
||
|