Open Design Tokens
    Preparing search index...

    Interface RuleMeta<Options>

    interface RuleMeta<Options> {
        defaultOptions?: Options;
        defaultSeverity: RuleSeverity;
        description: string;
        recommended?: boolean;
        validateOptions?(options: unknown): string | undefined;
    }

    Type Parameters

    • Options
    Index
    defaultOptions? defaultSeverity description recommended?
    validateOptions?
    defaultOptions?: Options

    Default options, merged under user options.

    defaultSeverity: RuleSeverity
    description: string
    recommended?: boolean

    Included in the recommended preset.

    • Returns a message when options are malformed; the engine then throws (programmer error).

      Parameters

      • options: unknown

      Returns string | undefined

    Settings
    Member Visibility

    On This Page
    Properties
    Methods