Class PnlOutcome

Realized-PnL result: either the amount or a halt reason.

Exactly one of pnl and haltReason is present.

Index

Constructors

Properties

haltReason isHalted ok pnl

Methods

[dispose] clone free

Constructors

constructor

new PnlOutcome(
pnl?: PnlOutcomeAmount | null,
halt_reason?: PnlHaltReason | null,
): PnlOutcome
Constructs a realized-PnL outcome.

Pass either a computed pnl or a haltReason created by a PnlHaltReason factory.

Errors

Throws TypeError unless exactly one of pnl and haltReason is present.
Parameters
- Optionalpnl: PnlOutcomeAmount | null
- Optionalhalt_reason: PnlHaltReason | null
Returns PnlOutcome
- Defined in src-ts/wasm/openpit_js.d.ts:4419

Properties

`Readonly`haltReason

haltReason: PnlHaltReason | undefined

The reason why PnL could not be calculated, or undefined when it is available.

`Readonly`isHalted

isHalted: boolean

Whether this accumulator halted during the operation.

`Readonly`ok

ok: boolean

Whether this outcome contains authoritative PnL.

`Readonly`pnl

pnl: PnlOutcomeAmount | undefined

The computed PnL, or undefined when a halt reason is present.

Methods

[dispose]

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

clone

clone(): PnlOutcome
Returns a deep copy of this PnL outcome.

Returns PnlOutcome
- Defined in src-ts/wasm/openpit_js.d.ts:4407

free

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