Skip to main contentreport-toolkit

RuleConfig

Hierarchy

  • RuleConfig

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new RuleConfig(rule: Rule, rawConfig?: any): RuleConfig

Parameters:

NameType
ruleRule
rawConfig?any

Returns: RuleConfig

Properties

config

config: any

Accessors

id

get id(): any

Returns: any


rule

get rule(): any

Returns: any

Methods

inspect

inspect(reports: Observable‹Report›): Observable‹Message

Parameters:

NameType
reportsObservable‹Report

Returns: Observable‹Message


validate

validate(rawConfig: any): any

validate the config against meta.schema using ajv

todo

Parameters:

NameType
rawConfigany

Returns: any

boolean


Static create

create(rule: any, rawConfig: any): Readonly‹RuleConfig

Parameters:

NameType
ruleany
rawConfigany

Returns: Readonly‹RuleConfig