DeserializeOptions | mongodb (original) (raw)

Index

Properties

OptionalallowObjectSmallerThanBufferSize

allowObjectSmallerThanBufferSize?: boolean

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

OptionalbsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

OptionalfieldsAsRaw

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

Optionalindex

index?: number

Offset into buffer to begin reading document from

OptionalpromoteBuffers

promoteBuffers?: boolean

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

OptionalpromoteLongs

promoteLongs?: boolean

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

OptionalpromoteValues

promoteValues?: boolean

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

Optionalraw

raw?: boolean

OptionaluseBigInt64

useBigInt64?: boolean

when deserializing a Long return as a BigInt.

Optionalvalidation

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.