Interface IPersistNotificationInstance

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

Each notification is keyed by its id and the read operation iterates over all stored notifications.

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

interface IPersistNotificationInstance {
    readNotificationData(): Promise<NotificationData>;
    waitForInit(initial: boolean): Promise<void>;
    writeNotificationData(notifications: NotificationData): Promise<void>;
}

Implemented by

PersistNotificationInstance

Index

Methods

readNotificationData waitForInit writeNotificationData

Methods

readNotificationData

readNotificationData(): Promise<NotificationData>
Read all persisted notifications by iterating storage keys.

Returns Promise<NotificationData>
Promise resolving to array of notification entries
- Defined in types.d.ts:15173

waitForInit

waitForInit(initial: boolean): Promise<void>
Initialize storage for this mode.
Parameters
- initial: boolean
  Whether this is the first initialization
Returns Promise<void>
Promise that resolves when initialization is complete
- Defined in types.d.ts:15167

writeNotificationData

writeNotificationData(notifications: NotificationData): Promise<void>
Write notifications to storage. Each notification is keyed by its id.
Parameters
- notifications: NotificationData
  Notification entries to persist
Returns Promise<void>
Promise that resolves when all writes are complete
- Defined in types.d.ts:15180