constructor

• new OrderMargin(): OrderMargin

  Constructs an empty margin group (autoBorrow false).

  Returns OrderMargin

autoBorrow

collateralAsset

• get collateralAsset(): string | undefined

  The collateral asset, or undefined.

  Returns string | undefined

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

  Sets the collateral asset.

  Errors

  Throws AssetError when the asset string is empty.

  Parameters

  • value: string | null | undefined

  Returns void

leverage

• get leverage(): Leverage | undefined

  The leverage multiplier, or undefined.

  Returns Leverage | undefined

• set leverage(
      value: string | number | bigint | Leverage | null | undefined,
  ): 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: string | number | bigint | Leverage | null | undefined

  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