constructor

• new OrderMargin(): OrderMargin

• Constructs an empty margin group (autoBorrow false).

  Returns OrderMargin

autoBorrow

collateralAsset

• get collateralAsset(): undefined | string

• The collateral asset, or undefined.

  Returns undefined | string
• set collateralAsset(value): void

• Sets the collateral asset.

  Errors

  Throws AssetError when the asset string is empty.

  Parameters

  • value: undefined | null | string

  Returns void

leverage

• get leverage(): undefined | Leverage

• The leverage multiplier, or undefined.

  Returns undefined | Leverage
• set leverage(value): void

• Sets the leverage (accepts a Leverage object or a number/bigint/string multiplier).

  Errors

  Throws ParamError on an out-of-range leverage value.

  Parameters

  • value:
        | undefined
        | null
        | string
        | number
        | bigint
        | Leverage

  Returns void

[dispose]

• [dispose](): void

• Returns void

clone

• clone(): OrderMargin

• Returns a deep copy of this margin group.

  Returns OrderMargin

free

• free(): void

• Returns void