Interface INotificationUtils

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

interface INotificationUtils {
    clear(): Promise<void>;
    getData(): Promise<NotificationModel[]>;
    handleBreakeven(data: BreakevenContract): Promise<void>;
    handleCriticalError(error: Error): Promise<void>;
    handleError(error: Error): Promise<void>;
    handlePartialLoss(data: PartialLossContract): Promise<void>;
    handlePartialProfit(data: PartialProfitContract): Promise<void>;
    handleRisk(data: RiskContract): Promise<void>;
    handleSignal(data: IStrategyTickResult): Promise<void>;
    handleStrategyCommit(data: StrategyCommitContract): Promise<void>;
    handleSync(data: SignalSyncContract): Promise<void>;
    handleValidationError(error: Error): Promise<void>;
}

Index

Methods

clear getData handleBreakeven handleCriticalError handleError handlePartialLoss handlePartialProfit handleRisk handleSignal handleStrategyCommit handleSync handleValidationError

Methods

clear

clear(): Promise<void>
Clears all stored notifications.

Returns Promise<void>
- Defined in types.d.ts:17189

getData

getData(): Promise<NotificationModel[]>
Gets all stored notifications.

Returns Promise<NotificationModel[]>
Array of all notification models
- Defined in types.d.ts:17185

handleBreakeven

handleBreakeven(data: BreakevenContract): Promise<void>
Handles breakeven availability event.
Parameters
- data: BreakevenContract
  The breakeven contract data
Returns Promise<void>
- Defined in types.d.ts:17150

handleCriticalError

handleCriticalError(error: Error): Promise<void>
Handles critical error event.
Parameters
- error: Error
  The error object
Returns Promise<void>
- Defined in types.d.ts:17175

handleError

handleError(error: Error): Promise<void>
Handles error event.
Parameters
- error: Error
  The error object
Returns Promise<void>
- Defined in types.d.ts:17170

handlePartialLoss

handlePartialLoss(data: PartialLossContract): Promise<void>
Handles partial loss availability event.
Parameters
- data: PartialLossContract
  The partial loss contract data
Returns Promise<void>
- Defined in types.d.ts:17145

handlePartialProfit

handlePartialProfit(data: PartialProfitContract): Promise<void>
Handles partial profit availability event.
Parameters
- data: PartialProfitContract
  The partial profit contract data
Returns Promise<void>
- Defined in types.d.ts:17140

handleRisk

handleRisk(data: RiskContract): Promise<void>
Handles risk rejection event.
Parameters
- data: RiskContract
  The risk contract data
Returns Promise<void>
- Defined in types.d.ts:17165

handleSignal

handleSignal(data: IStrategyTickResult): Promise<void>
Handles signal events (opened, closed, scheduled, cancelled).
Parameters
- data: IStrategyTickResult
  The strategy tick result data
Returns Promise<void>
- Defined in types.d.ts:17135

handleStrategyCommit

handleStrategyCommit(data: StrategyCommitContract): Promise<void>
Handles strategy commit events (partial-profit, breakeven, trailing, etc.).
Parameters
- data: StrategyCommitContract
  The strategy commit contract data
Returns Promise<void>
- Defined in types.d.ts:17155

handleSync

handleSync(data: SignalSyncContract): Promise<void>
Handles signal sync event (signal-open, signal-close).
Parameters
- data: SignalSyncContract
  The signal sync contract data
Returns Promise<void>
- Defined in types.d.ts:17160

handleValidationError

handleValidationError(error: Error): Promise<void>
Handles validation error event.
Parameters
- error: Error
  The error object
Returns Promise<void>
- Defined in types.d.ts:17180