Function createChannel

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

createChannel(
    name: string,
    config: ChannelConfig,
    ctx?: IPluginContext,
): NotificationChannel
Creates a NotificationChannel for the given channel entry.

Resolves the transport via createProvider, then wraps it in the matching channel class (EmailChannel, SmsChannel, PushChannel, or SlackChannel).
Parameters
- name: string
  The channel dispatch name
- config: ChannelConfig
  The channel configuration
- Optionalctx: IPluginContext
  The plugin context (required for 'mail', which resolves IMailer)
Returns NotificationChannel
The configured channel

Throws
If the provider type is unsupported or mail is used without MailPlugin

Since
0.1.0
- Defined in packages/notification-plugin/src/plugin/notification-plugin.ts:218

Function createChannel

Example

Since

Parameters

Returns NotificationChannel

Throws

Since

Settings