AdonisJS Notifications

This package creates a notifications service for use in AdonisJS v6 applications.

Install

Install the package:

npm install @benhepburn/adonis-notifications

or

pnpm install @benhepburn/adonis-notifications

or

yarn add @benhepburn/adonis-notifications

Then, configure the package for Adonis:

node ace configure @benhepburn/adonis-notifications

Configuration

Set the channel you wish to use for each notification type in config/notifications.ts.

Existing channels

• AWS SNS (currently only SMS)

Creating a channel

1. Set up a new AdonisJS package and add @benhepburn/adonis-notifications to the peer and dev dependencies.
2. Create a new class extending NotificationChannel and implement required members

Imports:

import { Notification, NotificationChannel } from '@benhepburn/adonis-notifications'