Type Alias NotificationService

Interface for notification service implementations.

Remarks

Defines the contract for sending notifications at different priority levels. Each method enriches the message with context information and sends it with an appropriate priority level.

Priority levels:

Error: High priority (1) - immediate attention required
Warning: Normal priority (0) - standard notification
Info: Low priority (-1) - informational only

Example

const service: NotificationService = createPushoverService(config);

// Error notifications are high priority
await service.notifyError("Critical failure", { caller: "PaymentService" });

// Warning notifications are normal priority
await service.notifyWarning("Slow response time", { caller: "APIMonitor" });

// Info notifications are low priority
await service.notifyInfo("Daily report generated", { caller: "ReportService" });

type NotificationService = {
    notifyError(
        message: string,
        context: NotificationContext,
    ): Promise<void>;
    notifyInfo(message: string, context: NotificationContext): Promise<void>;
    notifyWarning(message: string, context: NotificationContext): Promise<void>;
}

Index

Methods

notifyError notifyInfo notifyWarning

Methods

notifyError

notifyError(message: string, context: NotificationContext): Promise<void>
Sends a high-priority error notification.
Parameters
- message: string
  The error message to send
- context: NotificationContext
  Context information about the notification source
Returns Promise<void>
- Defined in packages/notification/types.ts:67

notifyInfo

notifyInfo(message: string, context: NotificationContext): Promise<void>
Sends a low-priority informational notification.
Parameters
- message: string
  The info message to send
- context: NotificationContext
  Context information about the notification source
Returns Promise<void>
- Defined in packages/notification/types.ts:81

notifyWarning

notifyWarning(message: string, context: NotificationContext): Promise<void>
Sends a normal-priority warning notification.
Parameters
- message: string
  The warning message to send
- context: NotificationContext
  Context information about the notification source
Returns Promise<void>
- Defined in packages/notification/types.ts:74

Type Alias NotificationService

Remarks

Example

Index

Methods

Methods

notifyError

Parameters

Returns Promise<void>

notifyInfo

Parameters

Returns Promise<void>

notifyWarning

Parameters

Returns Promise<void>

Settings

On This Page