Using Actions as Listeners

The AsListener interface allows you to trigger actions in response to events. This is useful for decoupling side effects from your main business logic.

Basic Example

Implement the AsListener interface and define the asListener method:

app/actions/send_welcome_email_action.ts

import { BaseAction, type AsListener } from '@foadonis/actions'
import mail from '@adonisjs/mail/services/main'
import User from '#models/user'

export default class SendWelcomeEmailAction extends BaseAction implements AsListener<User> {
  async handle(user: User) {
    await mail.send((message) => {
      message
        .to(user.email)
        .subject('Welcome!')
        .htmlView('emails/welcome', { user })
    })

    this.logger.info(`Welcome email sent to ${user.email}`)
  }

  async asListener(user: User) {
    await this.handle(user)
  }
}

Registering Listeners

start/events.ts

import emitter from '@adonisjs/core/services/emitter'
import { actions } from '#generated/actions'

emitter.on('user:registered', actions.SendWelcomeEmail.asListener())

Typed Event Payloads

For type-safe event payloads, define an event class:

app/events/user_registered.ts

import { BaseEvent } from '@adonisjs/core/events'
import User from '#models/user'

export default class UserRegistered extends BaseEvent {
  constructor(public user: User) {
    super()
  }
}

Then type the AsListener interface with the event class:

app/actions/send_welcome_email_action.ts

import { BaseAction, type AsListener } from '@foadonis/actions'
import mail from '@adonisjs/mail/services/main'
import UserRegistered from '#events/user_registered'

export default class SendWelcomeEmailAction extends BaseAction implements AsListener<UserRegistered> {
  async handle(email: string) {
    await mail.send((message) => {
      message
        .to(email)
        .subject('Welcome!')
        .htmlView('emails/welcome', { email })
    })

    this.logger.info(`Welcome email sent to ${email}`)
  }

  async asListener(event: UserRegistered) {
    await this.handle(event.user.email)
  }
}

start/events.ts

import emitter from '@adonisjs/core/services/emitter'
import { actions } from '#generated/actions'
import UserRegistered from '#events/user_registered'

emitter.on(UserRegistered, actions.SendWelcomeEmail.asListener())

Dispatch the event from anywhere in your application:

import UserRegistered from '#events/user_registered'

await UserRegistered.dispatch(user)

Basic Example

Registering Listeners

Typed Event Payloads

On this page