Class FinancialImpact

Financial impact group: realized P&L and fee.

Constructors

constructor

Accessors

fee pnl

Methods

[dispose] clone free

Constructors

constructor

  • new FinancialImpact(pnl, fee): FinancialImpact

  • 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

Accessors

fee

  • get fee(): undefined | Fee

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

    Returns undefined | Fee

  • set fee(value): void

  • Sets the fee.

    Errors

    Throws ParamError on an invalid value.

    Parameters

    • value:
          | string
          | number
          | bigint
          | Fee

    Returns void

pnl

  • get pnl(): undefined | Pnl

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

    Returns undefined | Pnl

  • set pnl(value): void

  • Sets the realized P&L.

    Errors

    Throws ParamError on an invalid value.

    Parameters

    • value:
          | string
          | number
          | bigint
          | Pnl

    Returns void

Methods

[dispose]

  • [dispose](): void

  • Returns void

clone

  • clone(): FinancialImpact

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

    Returns FinancialImpact

free

  • free(): void

  • Returns void

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods