Open Design Tokens
    Preparing search index...

    Interface FieldSpec

    interface FieldSpec {
        items?: "string" | "number" | "boolean" | "object";
        max?: number;
        min?: number;
        pattern?: RegExp;
        required?: boolean;
        type: "string" | "number" | "boolean" | "object" | "array";
        validate?(value: unknown): string | undefined;
    }
    Index
    items? max? min? pattern? required? type
    validate?
    items?: "string" | "number" | "boolean" | "object"

    For arrays: item type.

    max?: number
    min?: number

    For strings and arrays: length bounds. For numbers: value bounds.

    pattern?: RegExp

    For strings: must match. For arrays: applies to each string item.

    required?: boolean
    type: "string" | "number" | "boolean" | "object" | "array"

    • Custom check; return a message to report.

      Parameters

      • value: unknown

      Returns string | undefined

    Settings
    Member Visibility

    On This Page
    Properties
    Methods