rule
Describes a Rule
Index
Classes
Type aliases
- RuleDefinition
- RuleDefinitionId
- RuleDefinitionInspectFunction
- RuleDefinitionMeta
- RuleHandler
- RuleHandlerFunction
- RuleHandlerObject
Functions
Type aliases
RuleDefinition
Ƭ RuleDefinition: object
Type declaration:
id: string
inspect(): function
- (
config?: any): function | RuleHandlerObject | Promise‹function | RuleHandlerObject›
- (
meta: any
RuleDefinitionId
Ƭ RuleDefinitionId: string
RuleDefinitionInspectFunction
Ƭ RuleDefinitionInspectFunction: function
Type declaration:
▸ (config?: any): function | RuleHandlerObject | Promise‹function | RuleHandlerObject›
Parameters:
| Name | Type |
|---|---|
config? | any |
RuleDefinitionMeta
Ƭ RuleDefinitionMeta: any
RuleHandler
Ƭ RuleHandler: function | RuleHandlerObject
RuleHandlerFunction
Ƭ RuleHandlerFunction: function
Type declaration:
▸ (report: Report): string | void | Partial‹object› | Promise‹string | Partial‹object›› | string | object[]
Parameters:
| Name | Type |
|---|---|
report | Report |
RuleHandlerObject
Ƭ RuleHandlerObject: object
Type declaration:
complete(): function
- (): string | void | Partial‹object› | Promise‹string | Partial‹object››
next(): function
- (
report: Report): string | void | Partial‹object› | Promise‹string | Partial‹object›› | string | object[]
- (
Functions
createRule
▸ createRule(ruleDefinition: RuleDefinition): Rule
Creates a Rule from a user-defined (or builtin) RuleDefinition, which
is the exports of a rule definition file.
Parameters:
| Name | Type | Description |
|---|---|---|
ruleDefinition | RuleDefinition | Rule definition |
Returns: Rule
New rule