Class MLRule<T, O>

Type parameters

T: RuleConfigValue
O = null

Hierarchy

MLRule

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new MLRule(o: MLRuleOptions<T, O>): MLRule

- Defined in packages/@markuplint/ml-core/src/ml-rule/ml-rule.ts:17
Parameters
- o: MLRuleOptions<T, O>
Returns MLRule

Properties

Private #f

#f: MLRuleOptions<T, O>["fix"]

Private #v

#v: MLRuleOptions<T, O>["verify"]

Readonly defaultOptions

defaultOptions: O

Readonly defaultServerity

defaultServerity: Severity

Readonly defaultValue

defaultValue: T

Readonly name

name: string

Methods

fix

fix(document: Document<T, O>, rule: RuleInfo<T, O>): Promise<void>

- Defined in packages/@markuplint/ml-core/src/ml-rule/ml-rule.ts:49
Parameters
- document: Document<T, O>
- rule: RuleInfo<T, O>
Returns Promise<void>

optimizeOption

optimizeOption(configSettings: T | RuleConfig<T, O>): RuleInfo<T, O>

- Defined in packages/@markuplint/ml-core/src/ml-rule/ml-rule.ts:59
Parameters
- configSettings: T | RuleConfig<T, O>
Returns RuleInfo<T, O>

verify

verify(document: Document<T, O>, i18n: I18n, rule: RuleInfo<T, O>): Promise<VerifiedResult[]>

- Defined in packages/@markuplint/ml-core/src/ml-rule/ml-rule.ts:28
Parameters
- document: Document<T, O>
- i18n: I18n
- rule: RuleInfo<T, O>
Returns Promise<VerifiedResult[]>

Static create

create<T, O>(options: MLRuleOptions<T, O>): MLRule<T, O>

- Defined in packages/@markuplint/ml-core/src/ml-rule/ml-rule.ts:7
Type parameters
- T: RuleConfigValue
- O = null
Parameters
- options: MLRuleOptions<T, O>
Returns MLRule<T, O>

Generated using TypeDoc