Class PnlOutcomeAmount

A (delta, absolute) P&L pair describing an applied realized-P&L change.

The producing policy defines the denomination. SpotFunds position and account P&L outcomes use the account currency.

Index

Constructors

Properties

Methods

[dispose] clone free

Constructors

constructor

new PnlOutcomeAmount(delta, absolute): PnlOutcomeAmount
Constructs a P&L outcome amount from a delta and an absolute value.

Each argument accepts a Pnl value object or a DecimalInput.

Errors
Throws TypeError, RangeError, or ParamError when either argument is not a valid P&L value.
Parameters
- delta:
      | string
      | number
      | bigint
      | Pnl
- absolute:
      | string
      | number
      | bigint
      | Pnl
Returns PnlOutcomeAmount
- Defined in src-ts/wasm/openpit_js.d.ts:4099

Properties

`Readonly`absolute

absolute: Pnl

The resulting absolute P&L value.

`Readonly`delta

delta: Pnl

The signed P&L change applied.

Methods

[dispose]

[dispose](): void
Returns void
- Defined in src-ts/wasm/openpit_js.d.ts:4084

clone

clone(): PnlOutcomeAmount
Returns a fresh copy of this P&L outcome amount.

Returns PnlOutcomeAmount
- Defined in src-ts/wasm/openpit_js.d.ts:4088

free

free(): void
Returns void
- Defined in src-ts/wasm/openpit_js.d.ts:4083