Documentation
    Preparing search index...

    Interface SchemaOptions

    interface SchemaOptions {
        allowUnrecognizedEnumValues?: boolean;
        allowUnrecognizedUnionMembers?: boolean;
        breadcrumbsPrefix?: string[];
        omitUndefined?: boolean;
        skipValidation?: boolean;
        unrecognizedObjectKeys?: "fail" | "passthrough" | "strip";
    }
    Index

    Properties

    allowUnrecognizedEnumValues? allowUnrecognizedUnionMembers? breadcrumbsPrefix? omitUndefined? skipValidation? unrecognizedObjectKeys?

    Properties

    allowUnrecognizedEnumValues?: boolean

    whether to fail when an unrecognized enum value is encountered

    false
    allowUnrecognizedUnionMembers?: boolean

    whether to fail when an unrecognized discriminant value is encountered in a union

    false
    breadcrumbsPrefix?: string[]

    each validation failure contains a "path" property, which is the breadcrumbs to the offending node in the JSON. you can supply a prefix that is prepended to all the errors' paths. this can be helpful for zurg's internal debug logging.

    omitUndefined?: boolean

    whether to send 'null' for optional properties explicitly set to 'undefined'.

    skipValidation?: boolean

    whether to allow data that doesn't conform to the schema. invalid data is passed through without transformation.

    when this is enabled, .parse() and .json() will always return ok: true. .parseOrThrow() and .jsonOrThrow() will never fail.

    false
    unrecognizedObjectKeys?: "fail" | "passthrough" | "strip"

    how to handle unrecognized keys in objects

    "fail"

    Settings

    Member Visibility

    On This Page

    Properties