Type alias StringifyOptions

StringifyOptions: {
    compress?: boolean | {
        enable: boolean;
    };
    extended?: boolean | {
        enable: boolean;
        relaxed?: boolean;
    };
    minify?: boolean | {
        enable: boolean;
        keyMap?: Record<string, string>;
    };
}

Type for the options parameter of stringify.

Type declaration

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

    Determines if the output string will be compressed with lz4js.compress().

    Default Value

    false

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

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

    Default Value

    false

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

    Determines if the output string will have some of the keys replaced with a shorter identifier, a custom key map (original:shortened) can be supplied with the long form (only effective if enable is true.

    Default Value

    false

Settings

Member Visibility

Theme

Generated using TypeDoc