@openpit/engine
    Preparing search index...

    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
    • 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

    absolute: Pnl

    The resulting absolute P&L value.

    delta: Pnl

    The signed P&L change applied.

    • Returns void

    • Returns void