Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeserializeOptions

Hierarchy

  • DeserializeOptions

Index

Properties

allowObjectSmallerThanBufferSize?: boolean

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

defaultvalue

false

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

defaultvalue

false

fieldsAsRaw?: Document

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

defaultvalue

null

index?: number

Offset into buffer to begin reading document from

defaultvalue

0

promoteBuffers?: boolean

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

defaultvalue

false

promoteLongs?: boolean

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

defaultvalue

true

promoteValues?: boolean

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

defaultvalue

true

raw?: boolean
useBigInt64?: boolean

when deserializing a Long return as a BigInt.

defaultvalue

false

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.

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 } }

Type declaration

  • utf8: boolean | Record<string, true> | Record<string, false>

Generated using TypeDoc