Class AccountAdjustmentAccountPnlOperation

Account-wide PnL adjustment: authoritative value or explicit halt.

Constructors

constructor

Accessors

state

Methods

[dispose] clone free

Constructors

constructor

  • new AccountAdjustmentAccountPnlOperation(state): AccountAdjustmentAccountPnlOperation

  • Constructs an account-wide PnL adjustment.

    state accepts a Pnl, a DecimalInput, or a PnlHaltReason.

    Errors

    Throws TypeError, RangeError, or ParamError on an invalid state.

    Parameters

    • state:
          | string
          | number
          | bigint
          | PnlHaltReason
          | Pnl

    Returns AccountAdjustmentAccountPnlOperation

Accessors

state

  • get state(): PnlHaltReason | Pnl

  • The replacement PnL value or explicit halt reason.

    Returns PnlHaltReason | Pnl

  • set state(value): void

  • Sets the replacement PnL value or explicit halt reason.

    Errors

    Throws TypeError, RangeError, or ParamError on an invalid state.

    Parameters

    • value:
          | string
          | number
          | bigint
          | PnlHaltReason
          | Pnl

    Returns void

Methods

[dispose]

  • [dispose](): void

  • Returns void

clone

free

  • free(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods