@samatawy/checks
    Preparing search index...

    Interface SingleResult

    The base shape of a single validation result.

    interface SingleResult {
        valid: boolean;
        field?: string | number | null;
        hint?: string | string[];
        warn?: string | string[];
        err?: string | string[];
        code?: ResultCode;
    }

    Hierarchy (View Summary)

    Index

    Properties

    valid field? hint? warn? err? code?

    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.

    Settings

    Member Visibility

    On This Page

    Properties