Function NotificationPlugin

NotificationPlugin factory — registers an INotifier under CAPABILITIES.NOTIFICATION.

Example

import { NotificationPlugin } from '@setu-ts/notification-plugin';

app.register(NotificationPlugin({
  channels: {
    email: { provider: 'mail' },
    sms: { provider: 'twilio', options: { accountSid: '…', authToken: '…', from: '+1234' } },
  },
}));

Since

0.1.0

NotificationPlugin(options: NotificationPluginOptions): IPlugin

Creates the plugin factory.

Registers an INotifier under CAPABILITIES.NOTIFICATION backed by the configured channels and providers.

Parameters

options: NotificationPluginOptions
Plugin configuration

Returns IPlugin

The plugin instance

Example

import { NotificationPlugin } from '@setu-ts/notification-plugin';

app.register(NotificationPlugin({
  channels: {
    email: { provider: 'mail' },
    sms: {
      provider: 'twilio',
      options: { accountSid: '…', authToken: '…', from: '+1234' },
    },
    slack: { provider: 'slack', options: { webhookUrl: 'https://hooks.slack.com/…' } },
  },
}));

Since

0.1.0

Function NotificationPlugin

Example

Since

Parameters

Returns IPlugin

Example

Since

Settings