@samatawy/checks
    Preparing search index...

    Interface ResultSet

    A validation result that can aggregate child results and flattened messages.

    interface ResultSet {
        valid: boolean;
        field?: string | number | null;
        hint?: string | string[];
        warn?: string | string[];
        err?: string | string[];
        code?: ResultCode;
        input?: any;
        results?: IResult[];
        hints?: string[];
        warnings?: string[];
        errors?: string[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    valid field? hint? warn? err? code? input? results? hints? warnings? errors?

    Properties

    valid: boolean

    Indicates whether the result is valid.

    field?: string | number | null

    The field or index associated with the result, when applicable.

    hint?: string | string[]

    Informational guidance generated by the check.

    warn?: string | string[]

    Non-fatal warnings generated by the check.

    err?: string | string[]

    Validation errors generated by the check.

    code?: ResultCode

    Optional machine-readable code associated with the result.

    input?: any

    The original input value represented by this result set.

    results?: IResult[]

    Child results collected during nested validation.

    hints?: string[]

    Flattened hint messages collected from child results.

    warnings?: string[]

    Flattened warning messages collected from child results.

    errors?: string[]

    Flattened error messages collected from child results.

    Settings

    Member Visibility

    On This Page

    Properties