Skip to main content

Interface: RuleDefinitionWithDocs<MessageIds, Options>

Defined in: _internal/typed-rule.ts:42

Rule definition shape accepted by createTypedRule, including typed create(context, options) access with merged default options.

Type Parametersโ€‹

MessageIdsโ€‹

MessageIds extends string

Optionsโ€‹

Options extends Readonly<UnknownArray>

Propertiesโ€‹

createโ€‹

create: (context: GenericRuleContext<MessageIds, Options>, options: Options) =>
RuleListener;

Defined in: _internal/typed-rule.ts:46

Parametersโ€‹

contextโ€‹

GenericRuleContext<MessageIds, Options>

optionsโ€‹

Options

Returnsโ€‹

RuleListener


defaultOptions?โ€‹

optional defaultOptions?: Options;

Defined in: _internal/typed-rule.ts:50


metaโ€‹

meta: RuleDefinitionMetadataWithDocs<MessageIds, Options>;

Defined in: _internal/typed-rule.ts:51


nameโ€‹

name: string;

Defined in: _internal/typed-rule.ts:52