Class Notional

Constructors

constructor

Methods

[dispose] add calculateMarginRequired clone compare div equals free isZero mod mul sub toJSON toString toVolume fromFloat fromFloatRounded fromInt fromPriceQuantity fromString fromStringRounded fromVolume zero

Constructors

constructor

  • new Notional(value): Notional

  • Constructs from a DecimalInput (string | number | bigint).

    A generic number must be a safe integer. Use fromFloat explicitly for imprecise fractional input.

    Errors

    Throws ParamError on an invalid value or type.

    Parameters

    • value: string | number | bigint

    Returns Notional

Methods

[dispose]

  • [dispose](): void

  • Returns void

add

  • add(other): Notional

  • Returns the sum of self and other.

    Errors

    Throws ParamError on overflow (or sign violation for unsigned types).

    Parameters

    Returns Notional

calculateMarginRequired

  • calculateMarginRequired(leverage): Notional

  • Computes the margin required at the given leverage.

    Errors

    Throws ParamError on arithmetic overflow.

    Parameters

    Returns Notional

clone

  • clone(): Notional

  • Returns a fresh wrapper holding the same value.

    Value types are cheap to copy. Ordinary setters already borrow/clone wrapper inputs; this method is a convenience when an explicit second wrapper object is useful.

    Returns Notional

compare

  • compare(other): number

  • Compares against other: -1, 0, or 1.

    Parameters

    Returns number

div

  • div(scalar): Notional

  • Divides by a number | bigint scalar.

    Errors

    Throws ParamError on division by zero, overflow, or an invalid scalar.

    Parameters

    • scalar: number | bigint

    Returns Notional

equals

  • equals(other): boolean

  • Returns true when both values are equal.

    Parameters

    Returns boolean

free

  • free(): void

  • Returns void

isZero

  • isZero(): boolean

  • Returns true when the value is exactly zero.

    Returns boolean

mod

  • mod(scalar): Notional

  • Computes the remainder against a number | bigint scalar.

    Errors

    Throws ParamError on division by zero, overflow, or an invalid scalar.

    Parameters

    • scalar: number | bigint

    Returns Notional

mul

  • mul(scalar): Notional

  • Multiplies by a number | bigint scalar.

    bigint is exact; number is imprecise.

    Errors

    Throws ParamError on overflow or an invalid scalar.

    Parameters

    • scalar: number | bigint

    Returns Notional

sub

  • sub(other): Notional

  • Returns self minus other.

    Errors

    Throws ParamError on overflow/underflow.

    Parameters

    Returns Notional

toJSON

  • toJSON(): string

  • Returns the canonical decimal string for JSON serialization.

    Returns string

toString

  • toString(): string

  • Returns the canonical decimal string.

    Returns string

toVolume

  • toVolume(): Volume

  • Converts this notional into a volume.

    Returns Volume

StaticfromFloat

  • fromFloat(value): Notional

  • Constructs from a JS number (imprecise; prefer fromString).

    Errors

    Throws ParamError on a non-finite or out-of-domain value.

    Parameters

    • value: number

    Returns Notional

StaticfromFloatRounded

  • fromFloatRounded(value, scale, strategy): Notional

  • Constructs from a JS number then quantizes to scale.

    WARNING: the float source is imprecise; prefer fromStringRounded.

    Errors

    Throws ParamError on an invalid value, scale, or strategy.

    Parameters

    • value: number
    • scale: number
    • strategy: string

    Returns Notional

StaticfromInt

  • fromInt(value): Notional

  • Constructs from an exact integer (bigint).

    Errors

    Throws ParamError on an out-of-domain value.

    Parameters

    • value: bigint

    Returns Notional

StaticfromPriceQuantity

  • fromPriceQuantity(price, quantity): Notional

  • Builds a notional from price * quantity (absolute value).

    Errors

    Throws ParamError on arithmetic overflow.

    Parameters

    Returns Notional

StaticfromString

  • fromString(value): Notional

  • Constructs losslessly from a decimal string.

    Errors

    Throws ParamError on an invalid format or out-of-domain value.

    Parameters

    • value: string

    Returns Notional

StaticfromStringRounded

  • fromStringRounded(value, scale, strategy): Notional

  • Parses a decimal string then quantizes to scale using strategy.

    Errors

    Throws ParamError on an invalid value, scale, or strategy.

    Parameters

    • value: string
    • scale: number
    • strategy: string

    Returns Notional

StaticfromVolume

  • fromVolume(volume): Notional

  • Builds a notional from a volume (absolute value).

    Parameters

    Returns Notional

Staticzero

  • zero(): Notional

  • Returns the zero value.

    Returns Notional

Settings

Member Visibility

On This Page

Constructors
Methods