Skip to main content
Module

x/web_bson/mod.js>DeserializeOptions

web_bson is a fork from mongodb/js-bson
lucsoft/deno_bson
Very Popular
Latest
interface DeserializeOptions
import { type DeserializeOptions } from "https://deno.land/x/web_bson@v0.3.0/mod.js";

Properties

optional
useBigInt64: boolean

when deserializing a Long will return as a BigInt.

optional
promoteLongs: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.

optional
promoteBuffers: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

optional
promoteValues: boolean

when deserializing will promote BSON values to their Node.js closest equivalent types.

optional
fieldsAsRaw: Document

allow to specify if there what fields we wish to return as unserialized raw buffer.

optional
bsonRegExp: boolean

return BSON regular expressions as BSONRegExp instances.

optional
allowObjectSmallerThanBufferSize: boolean

allows the buffer to be larger than the parsed BSON object.

optional
index: number

Offset into buffer to begin reading document from

optional
raw: boolean
optional
validation: { utf8: boolean | Record<string, true> | Record<string, false>; }

Allows for opt-out utf-8 validation for all keys or specified keys. Must be all true or all false.