@openpit/engine
    Preparing search index...

    Class PnlHaltReason

    Reason why a realized-PnL value could not be calculated.

    When failures coincide, SpotFunds uses this priority from highest to lowest: fromArithmeticOverflow(), fromMissingAccountCurrency(), fromMissingFx(), fromMissingCostBasis(), then fromMissingInitialPnl().

    Index
    isArithmeticOverflow isMissingAccountCurrency isMissingCostBasis isMissingFx isMissingInitialPnl kind
    [dispose] clone free fromArithmeticOverflow fromMissingAccountCurrency fromMissingCostBasis fromMissingFx fromMissingInitialPnl
    isArithmeticOverflow: boolean

    Returns true when PnL arithmetic overflowed.

    isMissingAccountCurrency: boolean

    Returns true when the account currency was unavailable.

    isMissingCostBasis: boolean

    Returns true when the required position cost basis was unavailable.

    isMissingFx: boolean

    Returns true when no required FX quote was available.

    SpotFunds accepts stale quotes, so staleness alone does not set this reason.

    isMissingInitialPnl: boolean

    Returns true when no authoritative initial PnL was available.

    kind: PnlHaltReasonKind

    Stable wire discriminant suitable for logs, persistence, and switches.

    • Returns void

    • Returns a deep copy of this PnL halt reason.

      Returns PnlHaltReason

    • Returns void

    • Builds a halt reason for arithmetic outside the affected accumulator's supported PnL range.

      Returns PnlHaltReason

    • Builds a halt reason for a computation missing the account currency.

      Returns PnlHaltReason

    • Builds a halt reason for a position without the required cost basis.

      Returns PnlHaltReason

    • Builds a halt reason for a computation with no available required FX quote.

      SpotFunds accepts the latest known quote regardless of staleness. A stale quote alone does not halt P&L; this reason means no required quote was available and no authoritative P&L value could be calculated.

      Returns PnlHaltReason

    • Builds a halt reason for a position without authoritative initial PnL.

      Returns PnlHaltReason

    Settings
    Member Visibility

    On This Page
    Properties
    Methods