Interface IPersistStorageInstance

Per-context signal storage persistence instance interface. Scoped to either backtest or live mode (one instance per mode).

Each stored signal is keyed by its signal.id and the read operation iterates over all stored entries to return them as an array.

Custom adapters should implement this interface to override the default file-based signal storage behavior.

interface IPersistStorageInstance {
    readStorageData(): Promise<StorageData>;
    waitForInit(initial: boolean): Promise<void>;
    writeStorageData(signals: StorageData): Promise<void>;
}

Implemented by

Methods

  • Read all persisted signals by iterating storage keys.

    Returns Promise<StorageData>

    Promise resolving to array of signal entries

  • Initialize storage for this mode.

    Parameters

    • initial: boolean

      Whether this is the first initialization

    Returns Promise<void>

    Promise that resolves when initialization is complete

  • Write signals to storage. Each signal is keyed by its signal.id.

    Parameters

    Returns Promise<void>

    Promise that resolves when all writes are complete