interface INotifier
Since 0.1.0

Multi-channel notification dispatcher.

Examples

Example 1

const notifier = ctx.services.get<INotifier>(CAPABILITIES.NOTIFICATION);
await notifier.send({
  channels: ['email', 'sms'],
  to: { email: user.email, phone: user.phone },
  subject: 'Order shipped',
  body: 'Your order is on its way.',
});

Methods

send(notification: NotificationMessage): Promise<void>

Dispatches a notification on every requested channel.

Since 0.1.0
optional
sendSettled(notification: NotificationMessage): Promise<readonly ChannelSendResult[]>

Dispatches a notification on every requested channel and reports the settled outcome of each, without throwing.

Unlike INotifier.send, this never rejects: a failed channel is reported as { channel, ok: false, error } rather than raised, so a caller (typically one behind a retrying queue) can retry the failing channel alone instead of re-sending the whole notification. An unknown channel name is reported as ok: false, matching send's existing treatment of it as a failure.

Optional on the contract so existing implementors are not broken; resolve it with ?. and fall back to INotifier.send when absent.

Usage

import { type INotifier } from "notification-plugin/src/index.ts";