@openpit/engine
    Preparing search index...

    Class FinancialImpact

    Financial impact group: realized P&L and fee.

    Index
    constructor
    fee pnl
    [dispose] clone free

    • Constructs a financial-impact group from a P&L and a fee.

      Each argument accepts a value object or a DecimalInput.

      Errors

      Throws ParamError on an invalid value.

      Parameters

      • pnl: string | number | bigint | Pnl
      • fee: string | number | bigint | Fee

      Returns FinancialImpact

    • get fee(): Fee | undefined

      The fee, or undefined when omitted from a plain object.

      Returns Fee | undefined

    • set fee(value: string | number | bigint | Fee): void

      Sets the fee.

      Errors

      Throws ParamError on an invalid value.

      Parameters

      • value: string | number | bigint | Fee

      Returns void

    • get pnl(): Pnl | undefined

      The realized P&L, or undefined when omitted from a plain object.

      Returns Pnl | undefined

    • set pnl(value: string | number | bigint | Pnl): void

      Sets the realized P&L.

      Errors

      Throws ParamError on an invalid value.

      Parameters

      • value: string | number | bigint | Pnl

      Returns void

    • Returns void

    • Returns a fresh FinancialImpact holding the same P&L and fee.

      Returns FinancialImpact

    • Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Accessors
    Methods