Type alias ParseOptions

ParseOptions: {
    decompress?: boolean | {
        enable: boolean;
    };
    extended?: boolean | {
        enable: boolean;
        relaxed?: boolean;
    };
    unminify?: boolean | {
        enable: boolean;
        keyMap?: Record<string, string>;
    };
}

Type for the options parameter of parse.

Type declaration

  • Optional decompress?: boolean | {
        enable: boolean;
    }

    Specifies if the input string is compressed with lz4js.compress().

    Remarks

    Will automatically disable if the decompression fails.

    Default Value

    true

  • Optional extended?: boolean | {
        enable: boolean;
        relaxed?: boolean;
    }

    Specifies if the input string is in JSON or EJSON format, additional options to be passed into bson.EJSON.parse() can be supplied with the long form (only effective if enable is true.

    Default Value

    false

  • Optional unminify?: boolean | {
        enable: boolean;
        keyMap?: Record<string, string>;
    }

    Specifies if the input string is created with the minify option enabled in stringify, a custom key map (shortened:original) can be supplied with the long form (only effective if enable is true.

    Remarks

    Will automatically disable if the unminifcation fails.

    Default Value

    true

Settings

Member Visibility

Theme

Generated using TypeDoc