Skip to main content

Type Alias: RuleDefinitionWithDocs<MessageIds, Options>

type RuleDefinitionWithDocs<MessageIds, Options> = Except<
    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:29

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

metaโ€‹

meta: (RuleModuleWithDocs < MessageIds, Options > ["meta"]);

Type Parametersโ€‹

MessageIdsโ€‹

MessageIds extends string

Optionsโ€‹

Options extends Readonly<UnknownArray>