Skip to main content

Type Alias: RuleModuleWithDocs<MessageIds, Options>

type RuleModuleWithDocs<MessageIds, Options> = TSESLint.RuleModule<
    MessageIds,
    Options
> & {
    meta: TSESLint.RuleMetaData<MessageIds, SecretlintRuleDocs, Options> & {
        deprecated: boolean;
        docs: SecretlintRuleDocs;
        languages?: readonly ("*" | `${string}/${string}`)[];
    };
    name: string;
};

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

RuleModuleWithDocs rule module with docs contract.

Type Declarationโ€‹

metaโ€‹

meta: TSESLint.RuleMetaData<MessageIds, SecretlintRuleDocs, Options> & {
  deprecated: boolean;
  docs: SecretlintRuleDocs;
  languages?: readonly ("*" | `${string}/${string}`)[];
};

Type Declarationโ€‹

deprecatedโ€‹
deprecated: boolean;
docsโ€‹
docs: SecretlintRuleDocs;
languages?โ€‹
optional languages?: readonly ("*" | `${string}/${string}`)[];

nameโ€‹

name: string;

Type Parametersโ€‹

MessageIdsโ€‹

MessageIds extends string

Optionsโ€‹

Options extends Readonly<UnknownArray>