mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-23 22:52:29 +01:00
33 lines
975 B
Markdown
33 lines
975 B
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
|
|
||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getSaleGain](./bitburner.tix.getsalegain.md)
|
||
|
|
|
||
|
|
## TIX.getSaleGain() method
|
||
|
|
|
||
|
|
Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
getSaleGain(sym: StockSymbol, shares: number, posType: OrderPos): number;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
|
||
|
|
| shares | number | Number of shares to sell. |
|
||
|
|
| posType | [OrderPos](./bitburner.orderpos.md) | Specifies whether the order is a “Long” or “Short” position. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
number
|
||
|
|
|
||
|
|
Gain from selling a given number of shares of a stock.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
2 GB
|
||
|
|
|