Files
bitburner-src/markdown/bitburner.tix.getsalegain.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

1.2 KiB

Home > bitburner > TIX > getSaleGain

TIX.getSaleGain() method

Calculate profit of selling stocks.

Signature:

getSaleGain(sym: string, shares: number, positionType: PositionType): number;

Parameters

Parameter

Type

Description

sym

string

Stock symbol.

shares

number

Number of shares to sell.

positionType

PositionType

Specifies whether the order is a Long ("L") or Short ("S") position.

Returns:

number

Gain from selling a given number of shares of a stock.

Remarks

RAM cost: 2 GB 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.