Interface NotificationChannel

A way to reach someone.

The whole port, and it is small on purpose: a channel never decides whether to send. That is the application's call, and an application that models consent, preferences or quiet hours makes it before calling here. A channel that started deciding would be a second policy to keep in step with the first.

interface NotificationChannel {
    name: string;
    send: (
        message: RenderedNotification,
        recipient: Recipient,
    ) => Promise<DeliveryOutcome>;
}

Implemented by

Index

Properties

Properties

`Readonly`name

name: string

The name a notification refers to it by.

send

send: (
message: RenderedNotification,
recipient: Recipient,
) => Promise<DeliveryOutcome>

Send one message to one person.

Type Declaration

- (message: RenderedNotification, recipient: Recipient): Promise<DeliveryOutcome>
- Parameters
  - message: RenderedNotification
    The rendered notification.
  - recipient: Recipient
    Who it is for.
  Returns Promise<DeliveryOutcome>
  How it ended.