Library API
    Preparing search index...

    Interface ObjectifyOptions

    Configuration options for objectify() deserialization.

    interface ObjectifyOptions {
        allowClasses?: boolean;
        allowedClasses?: string[] | Set<string>;
        allowRegExp?: boolean;
        maxDepth?: number;
        requireSigned?: boolean;
        secret?: string;
        sentinel?: Function;
        throwOnError?: boolean;
    }
    Index
    allowClasses? allowedClasses? allowRegExp? maxDepth? requireSigned? secret? sentinel? throwOnError?
    allowClasses?: boolean

    Whether to allow instantiation of registered classes via Registry (default: true)

    allowedClasses?: string[] | Set<string>

    Optional allowlist of permitted registered class names (matched with or without leading '$')

    allowRegExp?: boolean

    Whether to reconstruct RegExp instances (default: true)

    maxDepth?: number

    Maximum object traversal nesting depth to prevent call-stack exhaustion (default: 64)

    requireSigned?: boolean

    If true, requires that the string has a valid signature, rejecting unsigned strings (default: false)

    secret?: string

    Secret key or salt to verify the signature against (required for signed verification)

    sentinel?: Function

    Optional function to handle reconstructing undefined/void values

    throwOnError?: boolean

    If true, throws an Error when signature verification fails, secret is missing, or payload is rejected (default: false)

    Settings
    Member Visibility

    On This Page
    Properties