Class ReferenceBook

Caller-owned registry of stable instrument identities and attributes.

Every method reads or writes the shared book, so every one of them throws InternalError once a module panic has poisoned the module instance.

Index

Constructors

Methods

[dispose] clearSettlementScheme free register registerWithId resolve setSettlementScheme settlementScheme

Constructors

constructor

new ReferenceBook(): ReferenceBook
Creates an empty reference book.

Returns ReferenceBook
- Defined in src-ts/wasm/openpit_js.d.ts:5490

Methods

[dispose]

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

clearSettlementScheme

clearSettlementScheme(
instrument_id: string | number | bigint | InstrumentId,
): void
Clears a registered instrument's settlement scheme.
Parameters
- instrument_id: string | number | bigint | InstrumentId
Returns void
- Defined in src-ts/wasm/openpit_js.d.ts:5486

free

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

register

register(instrument: Instrument | InstrumentInit): InstrumentId
Registers instrument under the next available instrument id.
Parameters
- instrument: Instrument | InstrumentInit
Returns InstrumentId
- Defined in src-ts/wasm/openpit_js.d.ts:5494

registerWithId

registerWithId(
instrument: Instrument | InstrumentInit,
instrument_id: string | number | bigint | InstrumentId,
): InstrumentId
Registers instrument under a caller-selected stable identifier.
Parameters
- instrument: Instrument | InstrumentInit
- instrument_id: string | number | bigint | InstrumentId
Returns InstrumentId
- Defined in src-ts/wasm/openpit_js.d.ts:5498

resolve

resolve(instrument: Instrument | InstrumentInit): InstrumentId | undefined
Resolves instrument to a registered id, or returns undefined.
Parameters
- instrument: Instrument | InstrumentInit
Returns InstrumentId | undefined
- Defined in src-ts/wasm/openpit_js.d.ts:5502

setSettlementScheme

setSettlementScheme(
instrument_id: string | number | bigint | InstrumentId,
settlement_scheme: SettlementScheme,
): void
Assigns a typed settlement scheme to a registered instrument.
Parameters
- instrument_id: string | number | bigint | InstrumentId
- settlement_scheme: SettlementScheme
Returns void
- Defined in src-ts/wasm/openpit_js.d.ts:5506

settlementScheme

settlementScheme(
instrument_id: string | number | bigint | InstrumentId,
): SettlementScheme | undefined
Returns a registered instrument's scheme, or undefined when unset.
Parameters
- instrument_id: string | number | bigint | InstrumentId
Returns SettlementScheme | undefined
- Defined in src-ts/wasm/openpit_js.d.ts:5510