Dictionary

Per-signal Map-like storage scoped by dictionary name.

Works like new Map() but the entries are bound to the CURRENT pending or scheduled signal: new Dictionary({ name: "llm" }).set("key", value) inside any strategy lifecycle callback. Unlike State, no context is passed through arguments — every instance method resolves the signal, mode and timestamp itself from backtest.methodContextService / backtest.executionContextService, so the class is unavailable outside async_hooks lifecycle callbacks by design.

Look-ahead bias protection: every entry is stamped with the logical when it was written at; a read happening at an earlier when does not see it, and a write with a smaller when overwrites (a restarted backtest resets live-written entries).

Requires an explicit Dictionary.enable() call before use — the subscription it creates disposes per-signal instances when the signal is cancelled or closed, preventing stale instances from accumulating.

Constructor

constructor(params: { name: string; });
Copy

Properties

params

params: any
Copy

enable

enable: (() => (...args: any[]) => any) & ISingleshotClearable<() => (...args: any[]) => any>
Copy

Enables dictionary storage by subscribing to signal lifecycle events. Clears memoized instances in DictionaryBacktest and DictionaryLive when a signal is cancelled or closed, preventing stale instances from accumulating. Uses singleshot to ensure one-time subscription.

disable

disable: () => void
Copy

Disables dictionary storage by unsubscribing from signal lifecycle events. Safe to call multiple times.

_get

_get: <Value_1 = unknown>(dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }, key: string) => Promise<Value_1>
Copy

Context-free read of the value stored under key. Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_set

_set: <Value_1 = unknown>(dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }, key: string, value: Value_1) => Promise<void>
Copy

Context-free write of value under key. Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_has

_has: (dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }, key: string) => Promise<boolean>
Copy

Context-free check whether a visible entry exists under key. Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_delete

_delete: (dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }, key: string) => Promise<boolean>
Copy

Context-free removal of the entry under key (hard delete). Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_clear

_clear: (dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }) => Promise<void>
Copy

Context-free removal of all entries (hard delete). Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_keys

_keys: (dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }) => Promise<string[]>
Copy

Context-free listing of visible entry keys (look-ahead-guarded). Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_values

_values: <Value_1 = unknown>(dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }) => Promise<Value_1[]>
Copy

Context-free listing of visible entry values (look-ahead-guarded). Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_entries

_entries: <Value_1 = unknown>(dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }) => Promise<[string, Value_1][]>
Copy

Context-free listing of visible [key, value] pairs (look-ahead-guarded). Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

_size

_size: (dto: { dictionaryName: string; signalId: string; backtest: boolean; when: Date; }) => Promise<number>
Copy

Context-free count of visible entries (look-ahead-guarded). Routes to DictionaryBacktest or DictionaryLive based on dto.backtest.

get

get: (key: string) => Promise<Value>
Copy

Read the value stored under key for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.

set

set: (key: string, value: Value) => Promise<void>
Copy

Write value under key for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.

has

has: (key: string) => Promise<boolean>
Copy

Check whether a visible entry exists under key for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.

delete

delete: (key: string) => Promise<boolean>
Copy

Remove the entry under key for the active pending or scheduled signal (hard delete). Resolves the signal, mode and timestamp from execution context — no context arguments required.

clear

clear: () => Promise<void>
Copy

Remove all entries for the active pending or scheduled signal (hard delete). Resolves the signal, mode and timestamp from execution context — no context arguments required.

keys

keys: () => Promise<string[]>
Copy

List keys of visible entries for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.

values

values: () => Promise<Value[]>
Copy

List values of visible entries for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.

entries

entries: () => Promise<[string, Value][]>
Copy

List [key, value] pairs of visible entries for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.

size

size: () => Promise<number>
Copy

Count visible entries for the active pending or scheduled signal. Resolves the signal, mode and timestamp from execution context — no context arguments required.