Skip to main content

Function: createTypedRule()

function createTypedRule<MessageIds, Options>(
    ruleDefinition: Readonly<
        Except<RuleDefinitionWithDocs<MessageIds, Options>, "meta"> & {
            meta: RuleMetadataWithDocs<MessageIds, Options>;
        }
    >
): RuleModuleWithDocs<MessageIds, Options>;

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

Identity-preserving rule creator with canonical docs URL enforcement.

Type Parametersโ€‹

MessageIdsโ€‹

MessageIds extends string

Optionsโ€‹

Options extends readonly unknown[]

Parametersโ€‹

ruleDefinitionโ€‹

Readonly<Except<RuleDefinitionWithDocs<MessageIds, Options>, "meta"> & { meta: RuleMetadataWithDocs<MessageIds, Options>; }>

Returnsโ€‹

RuleModuleWithDocs<MessageIds, Options>

Throwsโ€‹

TypeError when the rule's declared documentation URL is not the canonical URL for its rule name.