Class Rule

Provide methods that must be implement by all future rules

Hierarchy

Rule

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Rule(): Rule

- Defined in rules/rule.class.ts:21
Returns Rule

Properties

enabled

enabled: boolean

events

events: GitEventEnum[]

name

name: string

onBoth

onBoth: OnSuccessError[]

onError

onError: OnSuccessError[]

onSuccess

onSuccess: OnSuccessError[]

options

options: object

Methods

displayRule

displayRule(): void

- Defined in rules/rule.class.ts:30
Display each rule's properties

Returns void

isEnabled

isEnabled(webhook: Webhook, ruleConfig: any): false

- Defined in rules/rule.class.ts:46
Check if the rule can be apply to the received webhook, according to the ruleConfig

Parameters
- webhook: Webhook
- ruleConfig: any
Returns false

Abstract validate

validate(webhook: Webhook, ruleConfig: Rule, ruleResults?: RuleResult[]): Promise<RuleResult>

- Defined in rules/rule.class.ts:65
Abstract method that must be implemented by all rules. Contains all the business logic of the rule

Parameters
- webhook: Webhook
- ruleConfig: Rule
- Optional ruleResults: RuleResult[]
Returns Promise<RuleResult>

Generated using TypeDoc