Interface Parser

Description

Parsers interpret incoming events into one the refined event types.

interface Parser {
    getEventType(eventTypeInput: EventTypeInput): Promise<string>;
    getPayload(payloadInput: EventTypeInput): Promise<EventDto>;
    getRepoName(body?: Record<string, any>): string;
}

Implemented by

Index

Methods

getEventType getPayload getRepoName

Methods

getEventType

getEventType(eventTypeInput): Promise<string>
Parameters
- eventTypeInput: EventTypeInput
Returns Promise<string>
Description
Normalize the incoming type of event into the three supported categories: change, deployment, or incident.
- Defined in interfaces/Parser.ts:11

getPayload

getPayload(payloadInput): Promise<EventDto>
Parameters
- payloadInput: EventTypeInput
Returns Promise<EventDto>
Description
Get payload fields from the right places.
- Defined in interfaces/Parser.ts:16

getRepoName

getRepoName(body?): string
Parameters
- Optionalbody: Record<string, any>
Returns string
Description
Get the repository name.
- Defined in interfaces/Parser.ts:21