Type Alias: RuleDefinitionWithDocs<MessageIds, Options>

RuleDefinitionWithDocs<MessageIds, Options> = Omit<RuleModuleWithDocs<MessageIds, Options>, "create" | "meta"> & { create: (context: GenericRuleContext<MessageIds, Options>, options: Options) => TSESLint.RuleListener; meta: RuleModuleWithDocs<MessageIds, Options>["meta"]; }

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

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

Type Declaration

create

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

Parameters

context

GenericRuleContext<MessageIds, Options>

options

Options

Returns

TSESLint.RuleListener

Type Parameters

MessageIds

MessageIds extends string

Options

Options extends readonly unknown[]

Type Declaration​

create​

Parameters​

context​

options​

Returns​

meta​

Type Parameters​

MessageIds​

Options​