Class CheckCoverageRule

CheckCoverageRule checks if coverage fulfill the options.

returns: return a RuleResult object

Hierarchy

Rule
- CheckCoverageRule

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CheckCoverageRule(httpService: HttpService, googleAnalytics: Visitor): CheckCoverageRule

Overrides Rule.constructor
- Defined in rules/checkCoverage.rule.ts:28
Parameters
- httpService: HttpService
- googleAnalytics: Visitor
Returns CheckCoverageRule

Properties

enabled

enabled: boolean

events

events: GitEventEnum[] = [GitEventEnum.Cron]

Private googleAnalytics

googleAnalytics: Visitor

Private httpService

httpService: HttpService

name

name: string

onBoth

onBoth: OnSuccessError[]

onError

onError: OnSuccessError[]

onSuccess

onSuccess: OnSuccessError[]

options

options: CheckCoverageOptions

Methods

displayRule

displayRule(): void

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

Returns void

isEnabled

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

Inherited from Rule.isEnabled
- 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

validate

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

Overrides Rule.validate
- Defined in rules/checkCoverage.rule.ts:38
Parameters
- webhook: Webhook
- ruleConfig: CheckCoverageRule
- Optional ruleResults: RuleResult[]
Returns Promise<RuleResult>

Generated using TypeDoc