Interface ISessionInstance

Interface for session instance implementations. Defines the contract for local, persist, and dummy backends.

Intended use: per-(symbol, strategy, exchange, frame) mutable session data shared across strategy callbacks within a single run — e.g. caching LLM inference results, intermediate indicator state, or cross-candle accumulators.

Example shape:

{ lastLlmSignal: "buy" | "sell" | null; confirmedAt: number }
interface ISessionInstance {
    dispose(): Promise<void>;
    getData<Value extends object = object>(when: Date): Promise<Value>;
    setData<Value extends object = object>(
        value: Value,
        when: Date,
    ): Promise<void>;
    waitForInit(initial: boolean): Promise<void>;
}

Methods

dispose getData setData waitForInit

Methods

dispose

  • dispose(): Promise<void>

    Releases any resources held by this instance.

    Returns Promise<void>

getData

  • getData<Value extends object = object>(when: Date): Promise<Value>

    Read the current session value. Returns null when the stored when is greater than the requested when (look-ahead bias protection).

    Type Parameters

    • Value extends object = object

    Parameters

    • when: Date

      Logical timestamp at which the read is happening

    Returns Promise<Value>

    Current session value, or null if not set / look-ahead

setData

  • setData<Value extends object = object>(value: Value, when: Date): Promise<void>

    Write a new session value.

    Type Parameters

    • Value extends object = object

    Parameters

    • value: Value

      New value or null to clear

    • when: Date

      Logical timestamp this value belongs to. A write with a smaller when overwrites an existing record — that lets a restarted backtest reset live-written state.

    Returns Promise<void>

waitForInit

  • waitForInit(initial: boolean): Promise<void>

    Initialize the session instance.

    Parameters

    • initial: boolean

      Whether this is the first initialization

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods