bunway
    Preparing search index...

    Interface FieldRule

    interface FieldRule {
        custom?: (
            value: unknown,
            req: BunRequest,
        ) => string | boolean | Promise<string | boolean>;
        enum?: unknown[];
        max?: number;
        message?: string;
        min?: number;
        pattern?: RegExp;
        required?: boolean;
        toLowerCase?: boolean;
        toNumber?: boolean;
        trim?: boolean;
        type?: string;
    }
    Index

    Properties

    custom? enum? max? message? min? pattern? required? toLowerCase? toNumber? trim? type?

    Properties

    custom?: (
        value: unknown,
        req: BunRequest,
    ) => string | boolean | Promise<string | boolean>

    Custom validator function. Return true if valid, false or string (error message) if invalid.

    enum?: unknown[]

    Enumeration of allowed values

    max?: number

    Maximum length (strings) or maximum value (numbers)

    message?: string

    Custom error message for this field

    min?: number

    Minimum length (strings) or minimum value (numbers)

    pattern?: RegExp

    Regex pattern the value must match

    required?: boolean

    Mark field as required. Default: false

    toLowerCase?: boolean

    Convert to lowercase before validation (strings only). Default: false

    toNumber?: boolean

    Convert to number before validation. Default: false

    trim?: boolean

    Trim whitespace before validation (strings only). Default: false

    type?: string

    Field type: "string", "number", "boolean", "email", "url", "uuid", "integer"

    Settings

    Member Visibility

    On This Page

    Properties