Module "pack/notification/notification"

Index

Interfaces

NotificationOptions

Type aliases

Functions

Type aliases

DestinationFactory

DestinationFactory: (goal: SdmGoalEvent, context: SdmContext) => Promise<Destination | Destination[] | undefined>

Factory to create message destinations for goal notifications

Type declaration

- (goal: SdmGoalEvent, context: SdmContext): Promise<Destination | Destination[] | undefined>
- Parameters
  - goal: SdmGoalEvent
  - context: SdmContext
  Returns Promise<Destination | Destination[] | undefined>

NotificationFactory

NotificationFactory: (gi: GoalCompletionListenerInvocation) => Promise<{ message: any; options: MessageOptions }>

Factory to create notification messages

Type declaration

- (gi: GoalCompletionListenerInvocation): Promise<{ message: any; options: MessageOptions }>
- Parameters
  - gi: GoalCompletionListenerInvocation
  Returns Promise<{ message: any; options: MessageOptions }>

Functions

defaultDestinationFactory

defaultDestinationFactory(goal: SdmGoalEvent): Promise<Destination | Destination[] | undefined>

- Defined in lib/pack/notification/notification.ts:102
Default DestinationFactory that would send every commit author a direct message in Slack / MS Teams.

Parameters
- goal: SdmGoalEvent
Returns Promise<Destination | Destination[] | undefined>

defaultNotificationFactory

defaultNotificationFactory(updateGoalCommand: CommandHandlerRegistration<any>): NotificationFactory

- Defined in lib/pack/notification/notification.ts:117
Default NotificationFactory that sends messages with restart, start and approve buttons where appropriate.

Parameters
- updateGoalCommand: CommandHandlerRegistration<any>
Returns NotificationFactory

notificationSupport

notificationSupport(options?: NotificationOptions): ExtensionPack

- Defined in lib/pack/notification/notification.ts:79
Extension pack to send notifications on certain conditions. Recipients and notification messages can be customized by providing options with DestinationFactory and NotificationFactory.

Parameters
- Default value options: NotificationOptions = {}
Returns ExtensionPack

notifyGoalCompletionListener

notifyGoalCompletionListener(options: NotificationOptions): GoalCompletionListener

- Defined in lib/pack/notification/notification.ts:200
GoalCompletionListener that delegates to the NotificationFactory and DestinationFactory to create notifications and send them out.

Parameters
- options: NotificationOptions
Returns GoalCompletionListener

truncateCommitMessage

truncateCommitMessage(message: string): string

- Defined in lib/pack/notification/notification.ts:222
Parameters
- message: string
Returns string

Generated using TypeDoc