Sending Notifications

Basic Usage

Notifications are sent using the notify function, which returns a fluent API for configuring delivery options.

import { notify } from '@holo-js/notifications'
import { invoicePaid } from './notifications'

await notify(user, invoicePaid)

Sending to Multiple Users

Use notifyMany to fan out a notification to an array of notifiables:

import { notifyMany } from '@holo-js/notifications'

await notifyMany(users, invoicePaid)

Fluent Configuration Options

The notify function returns a fluent builder that allows you to configure various aspects of the notification delivery:

Queueing

await notify(user, invoicePaid)
  .onQueue('notifications')

Delayed Delivery

// Delay all channels by 5 minutes
await notify(user, invoicePaid)
  .delay(300)

// Delay specific channels
await notify(user, invoicePaid)
  .delayFor('email', 300)      // Email delayed 5 minutes
  .delayFor('broadcast', 0)    // Broadcast immediately

Transaction Awareness

await notify(user, invoicePaid)
  .afterCommit()

Anonymous Notifications

Use notifyUsing() to send notifications without a notifiable model by providing routes directly:

import { notifyUsing } from '@holo-js/notifications'

await notifyUsing()
  .channel('email', { email: '[email protected]', name: 'Ava' })
  .channel('database', { id: 'user-1', type: 'users' })
  .notify(invoicePaid)