@samatawy/checks
    Preparing search index...

    Interface StringCheckOptions

    Options specific to string-based checks.

    interface StringCheckOptions {
        hint?: string | string[];
        warn?: string | string[];
        err?: string | string[];
        code?: ResultCode;
        catalog?: IResultCatalog;
        case?: "sensitive" | "insensitive";
    }

    Hierarchy (View Summary)

    Index

    Properties

    hint? warn? err? code? catalog? case?

    Properties

    hint?: string | string[]

    Custom hint message or messages to add when the check records a hint.

    warn?: string | string[]

    Custom warning message or messages to add when the check records a warning.

    err?: string | string[]

    Custom error message or messages to add when the check records an error.

    code?: ResultCode

    Optional code attached to the produced result.

    catalog?: IResultCatalog

    Catalog used to resolve result codes into localized messages.

    case?: "sensitive" | "insensitive"

    Controls case-sensitive versus case-insensitive matching.

    Settings

    Member Visibility

    On This Page

    Properties