Class PositionSide

Position direction: long or short.

Index

Methods

[dispose] free isLong isShort opposite toJSON toString fromString long short

Methods

[dispose]

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

free

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

isLong

isLong(): boolean
Returns true for the long side.

Returns boolean
- Defined in src-ts/wasm/openpit_js.d.ts:4568

isShort

isShort(): boolean
Returns true for the short side.

Returns boolean
- Defined in src-ts/wasm/openpit_js.d.ts:4572

opposite

opposite(): PositionSide
Returns the opposite position side.

Returns PositionSide
- Defined in src-ts/wasm/openpit_js.d.ts:4580

toJSON

toJSON(): string
Returns the wire string for JSON serialization.

Returns string
- Defined in src-ts/wasm/openpit_js.d.ts:4588

toString

toString(): string
Returns the canonical wire string ("LONG"/"SHORT").

Returns string
- Defined in src-ts/wasm/openpit_js.d.ts:4592

`Static`fromString

fromString(value: string): PositionSide
Parses a position side from its wire string ("LONG"/"SHORT").
Parameters
- value: string
Returns PositionSide
- Defined in src-ts/wasm/openpit_js.d.ts:4564

`Static`long

long(): PositionSide
The long side.

Returns PositionSide
- Defined in src-ts/wasm/openpit_js.d.ts:4576

`Static`short

short(): PositionSide
The short side.

Returns PositionSide
- Defined in src-ts/wasm/openpit_js.d.ts:4584