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: PositionSize | undefined

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

`Readonly`asDelta

asDelta: PositionSize | undefined

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:1669

clone

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

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

free

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

`Static`absolute

absolute(value: string | number | bigint | PositionSize): 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:1679

`Static`delta

delta(value: string | number | bigint | PositionSize): 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:1693