@samatawy/checks
    Preparing search index...

    Interface ResultOptions

    Controls how a check formats and returns its result.

    interface ResultOptions {
        language?: string;
        catalog?: IResultCatalog;
        raw?: boolean;
        nested?: boolean;
        validated?: "partial" | "strict";
        flattened?: boolean;
    }
    Index

    Properties

    language? catalog? raw? nested? validated? flattened?

    Properties

    language?: string

    Preferred language for catalog-resolved messages.

    catalog?: IResultCatalog

    Catalog used to resolve result codes during result generation.

    raw?: boolean

    Returns the original nested result structure without post-processing.

    nested?: boolean

    Returns results grouped by field where supported.

    validated?: "partial" | "strict"

    Returns the validated input value using either partial or strict pruning.

    flattened?: boolean

    Returns flattened top-level hint, warning, and error arrays.

    Settings

    Member Visibility

    On This Page

    Properties