Class AdjustmentAmount

A tagged balance/position adjustment amount: delta or absolute.

Index

Properties

asAbsolute asDelta isAbsolute isDelta

Methods

[dispose] clone free absolute delta

Properties

`Readonly`asAbsolute

asAbsolute: undefined | PositionSize

Returns the absolute size, or undefined when this is a delta.

`Readonly`asDelta

asDelta: undefined | PositionSize

Returns the delta size, or undefined when this is absolute.

`Readonly`isAbsolute

isAbsolute: boolean

Returns true when this amount is an absolute target.

`Readonly`isDelta

isDelta: boolean

Returns true when this amount is a signed difference.

Methods

[dispose]

[dispose](): void
Returns void
- Defined in src-ts/wasm/openpit_js.d.ts:1382

clone

clone(): AdjustmentAmount
Returns a fresh AdjustmentAmount holding the same value.

Returns AdjustmentAmount
- Defined in src-ts/wasm/openpit_js.d.ts:1396

free

free(): void
Returns void
- Defined in src-ts/wasm/openpit_js.d.ts:1381

`Static`absolute

absolute(value): AdjustmentAmount
Builds an absolute-target adjustment amount.

Accepts a PositionSize value object or a DecimalInput.

Errors
Throws ParamError on an invalid value.
Parameters
- value:
      | string
      | number
      | bigint
      | PositionSize
Returns AdjustmentAmount
- Defined in src-ts/wasm/openpit_js.d.ts:1392

`Static`delta

delta(value): AdjustmentAmount
Builds a signed-difference (delta) adjustment amount.

Accepts a PositionSize value object or a DecimalInput.

Errors
Throws ParamError on an invalid value.
Parameters
- value:
      | string
      | number
      | bigint
      | PositionSize
Returns AdjustmentAmount
- Defined in src-ts/wasm/openpit_js.d.ts:1406