@openpit/engine
    Preparing search index...

    Class Leverage

    Fixed-point leverage multiplier (scale 10, range 1.0..=3000.0, step 0.1).

    Index
    value
    [dispose] calculateMarginRequired clone free toString fromFloat fromInt MAX MIN SCALE STEP
    value: number

    Returns the normalized multiplier as a JS number.

    • Returns void

    • Computes the margin required to support notional at this leverage.

      Errors

      Throws ParamError on arithmetic overflow.

      Parameters

      Returns Notional

    • Returns a fresh Leverage holding the same multiplier.

      Returns Leverage

    • Returns void

    • Returns the canonical multiplier string.

      Returns string

    • Builds leverage from a fractional multiplier (e.g. 2.5).

      WARNING: floats are imprecise; values are snapped to the scale-10 grid.

      Errors

      Throws ParamError when the value is non-finite or outside the valid range/step.

      Parameters

      • value: number

      Returns Leverage

    • Builds leverage from an integer multiplier (e.g. 10 for 10x).

      Errors

      Throws ParamError when the multiplier is outside 1..=3000.

      Parameters

      • value: number

      Returns Leverage

    • The maximum integer multiplier (3000).

      Returns number

    • The minimum integer multiplier (1).

      Returns number

    • The fixed-point scale (10).

      Returns number

    • The smallest representable step (0.1).

      Returns number

    Settings
    Member Visibility

    On This Page
    Properties
    Methods