Interface DeserializeOptions

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

Default Value

false

return BSON regular expressions as BSONRegExp instances.

Default Value

false

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

Default Value

null

Offset into buffer to begin reading document from

Default Value

0

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

Default Value

false

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

Default Value

true

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

Default Value

true

when deserializing a Long return as a BigInt.

Default Value

false

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

Example

// disables validation on all keys
 validation: { utf8: false }

// enables validation only on specified keys a, b, and c
 validation: { utf8: { a: true, b: true, c: true } }

 // disables validation only on specified keys a, b
 validation: { utf8: { a: false, b: false } }
Copy