DeserializeOptions | /deps.ts | atlas_sdk3@v0.3.1

interface DeserializeOptions

import { type DeserializeOptions } from "https://dotland.deno.dev/x/atlas_sdk3@v0.3.1/deps.ts";

Properties

optional

evalFunctions: boolean

evaluate functions in the BSON document scoped to the object deserialized.

optional

cacheFunctions: boolean

cache evaluated functions for reuse.

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.

import DeserializeOptions

import { DeserializeOptions } from "https://dotland.deno.dev/x/atlas_sdk3@v0.3.1/deps.ts";