Skip to main content

Type Alias: RuleDocsMetadata

type RuleDocsMetadata = Readonly<{
description: string;
recommended: boolean;
requiresTypeChecking: boolean;
ruleId: string;
ruleNumber: number;
typefestConfigNames: readonly TypefestConfigName[];
typefestConfigReferences: readonly TypefestConfigReference[];
url: string;
}>;

Defined in: _internal/rule-docs-metadata.ts:27

Normalized docs metadata derived for each rule.