BSONSerializeOptions

BSON Serialization options.

Hierarchy

Omit<SerializeOptions, "index">
Omit<DeserializeOptions, "evalFunctions" | "cacheFunctions" | "cacheFunctionsCrc32" | "allowObjectSmallerThanBufferSize" | "index" | "validation">
- BSONSerializeOptions

Index

Properties

Optional bsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

Optional checkKeys

checkKeys?: boolean

the serializer will check if keys are valid.

Optional enableUtf8Validation

enableUtf8Validation?: boolean

Enable utf8 validation when deserializing BSON documents. Defaults to true.

Optional fieldsAsRaw

fieldsAsRaw?: Document

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

Optional ignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields (default:true)

Optional promoteBuffers

promoteBuffers?: boolean

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

Optional promoteLongs

promoteLongs?: boolean

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

Optional promoteValues

promoteValues?: boolean

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

Optional raw

raw?: boolean

Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:

example

const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point

remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

Optional serializeFunctions

serializeFunctions?: boolean

serialize the javascript functions (default:false).