UNPKG

@report-toolkit/inspector

Version:

See docs at [https://ibm.github.io/report-toolkit](https://ibm.github.io/report-toolkit)

37 lines (36 loc) 1.13 kB
/** * Describes a configuration of a Rule * @module @report-toolkit/inspector.rule-config * */ /** */ export class RuleConfig { static create(rule: any, rawConfig: any): Readonly<RuleConfig>; /** * * @param {import('./rule').Rule} rule * @param {Object} [rawConfig] */ constructor(rule: import('./rule').Rule, rawConfig?: any); config: any; get rule(): any; get id(): any; /** * validate the config against meta.schema using ajv * @todo * @param {Object} rawConfig * @returns boolean */ validate(rawConfig: any): any; /** * * @param {import('rxjs').Observable<import('@report-toolkit/common/src/report').Report>} reports * @returns {import('rxjs').Observable<import('./message').Message>} */ inspect(reports: import('rxjs').Observable<import('@report-toolkit/common/src/report').Report>): import('rxjs').Observable<import('./message').Message>; } /** * @type {(rawConfig: object, rule: import('./rule').Rule) => RuleConfig} */ export const createRuleConfig: (rawConfig: object, rule: import('./rule').Rule) => RuleConfig;