Interface IStorageUtils

Base interface for storage adapters. All storage adapters must implement this interface.

interface IStorageUtils {
    findById(id: string): Promise<IStorageSignalRow>;
    handleActivePing(event: ActivePingContract): Promise<void>;
    handleCancelled(tick: IStrategyTickResultCancelled): Promise<void>;
    handleClosed(tick: IStrategyTickResultClosed): Promise<void>;
    handleOpened(tick: IStrategyTickResultOpened): Promise<void>;
    handleScheduled(tick: IStrategyTickResultScheduled): Promise<void>;
    handleSchedulePing(event: SchedulePingContract): Promise<void>;
    list(): Promise<IStorageSignalRow[]>;
}

Index

Methods

findById handleActivePing handleCancelled handleClosed handleOpened handleScheduled handleSchedulePing list

Methods

findById

findById(id: string): Promise<IStorageSignalRow>
Finds a signal by its ID.
Parameters
- id: string
  The signal ID to search for
Returns Promise<IStorageSignalRow>
The signal row or null if not found
- Defined in types.d.ts:21912

handleActivePing

handleActivePing(event: ActivePingContract): Promise<void>
Handles active ping event for opened signals. Updates updatedAt for the signal if it is currently opened.
Parameters
- event: ActivePingContract
  The active ping event data
Returns Promise<void>
- Defined in types.d.ts:21923

handleCancelled

handleCancelled(tick: IStrategyTickResultCancelled): Promise<void>
Handles signal cancelled event.
Parameters
- tick: IStrategyTickResultCancelled
  The cancelled signal tick data
Returns Promise<void>
- Defined in types.d.ts:21906

handleClosed

handleClosed(tick: IStrategyTickResultClosed): Promise<void>
Handles signal closed event.
Parameters
- tick: IStrategyTickResultClosed
  The closed signal tick data
Returns Promise<void>
- Defined in types.d.ts:21896

handleOpened

handleOpened(tick: IStrategyTickResultOpened): Promise<void>
Handles signal opened event.
Parameters
- tick: IStrategyTickResultOpened
  The opened signal tick data
Returns Promise<void>
- Defined in types.d.ts:21891

handleScheduled

handleScheduled(tick: IStrategyTickResultScheduled): Promise<void>
Handles signal scheduled event.
Parameters
- tick: IStrategyTickResultScheduled
  The scheduled signal tick data
Returns Promise<void>
- Defined in types.d.ts:21901

handleSchedulePing

handleSchedulePing(event: SchedulePingContract): Promise<void>
Handles schedule ping event for scheduled signals. Updates updatedAt for the signal if it is currently scheduled.
Parameters
- event: SchedulePingContract
  The schedule ping event data
Returns Promise<void>
- Defined in types.d.ts:21929

list

list(): Promise<IStorageSignalRow[]>
Lists all stored signals.

Returns Promise<IStorageSignalRow[]>
Array of all signal rows
- Defined in types.d.ts:21917