Skip to main content

Digest

The Digest class is used to create a digest object which can group events together and send them at a specified time with a specified schedule.

Constructor

  • name: The name of the digest.
  • options:
    • cron: A cron string specifying the schedule.
    • email: The email address where the digest will be sent.

Methods

  • Pushes a GitHub event to the digest.

Examples

events

Provides a whay to handle events from various sources. Events can be pushed to a Digest or, if they are not important, you can just ignore them.

Methods

  • Registers an event listener for a specified source.
  • source: The source of the event.
    • The only supported source right now is github.
  • callback: The callback function to handle the event.

Examples

settings

Methods

  • Sets the timezone for the module.
  • timezone: The timezone string.

Examples