Class GithubEventRouter

Subscribes to the generic github topic and publishes the events under the more concrete sub-topic depending on the x-github-event provided.

Hierarchy (View Summary)

SubTopicEventRouter
- GithubEventRouter

Index

Constructors

Methods

determineDestinationTopic determineSubTopic getSubscriberId onEvent subscribe

Constructors

constructor

new GithubEventRouter(options: { events: EventsService }): GithubEventRouter
Parameters
- options: { events: EventsService }
Returns GithubEventRouter
Overrides SubTopicEventRouter.constructor
- Defined in plugins/events-backend-module-github/src/router/GithubEventRouter.ts:31

Methods

`Protected`determineDestinationTopic

determineDestinationTopic(params: EventParams): string | undefined
Parameters
- params: EventParams
Returns string | undefined
Inherited from SubTopicEventRouter.determineDestinationTopic
- Defined in plugins/events-node/src/api/SubTopicEventRouter.ts:40

`Protected`determineSubTopic

determineSubTopic(params: EventParams): string | undefined
Parameters
- params: EventParams
Returns string | undefined
Overrides SubTopicEventRouter.determineSubTopic
- Defined in plugins/events-backend-module-github/src/router/GithubEventRouter.ts:42

`Protected`getSubscriberId

getSubscriberId(): string
Returns string
Overrides SubTopicEventRouter.getSubscriberId
- Defined in plugins/events-backend-module-github/src/router/GithubEventRouter.ts:38

onEvent

onEvent(params: EventParams): Promise<void>
Parameters
- params: EventParams
Returns Promise<void>
Inherited from SubTopicEventRouter.onEvent
- Defined in plugins/events-node/src/api/EventRouter.ts:62

subscribe(): Promise<void>
Subscribes itself to the topic(s), after which events potentially can be received and processed by EventRouter.onEvent.

Returns Promise<void>
Inherited from SubTopicEventRouter.subscribe
- Defined in plugins/events-node/src/api/EventRouter.ts:48