Create a new Binary instance.
This constructor can accept a string as its first argument. In this case,
this string will be encoded using ISO-8859-1, not using UTF-8.
This is almost certainly not what you want. Use new Binary(Buffer.from(string))
instead to convert the string to a Buffer using UTF-8 first.
Optional
buffer: string | BinarySequencea buffer object containing the binary data.
Optional
Optional
subType: numberthe option binary type.
Optional
Static
Readonly
BUFFER_Initial buffer default size
Static
Readonly
SUBTYPE_Byte Array BSON type
Static
Readonly
SUBTYPE_Column BSON type
Static
Readonly
SUBTYPE_Default BSON type
Static
Readonly
SUBTYPE_Encrypted BSON type
Static
Readonly
SUBTYPE_Function BSON type
Static
Readonly
SUBTYPE_MD5 BSON type
Static
Readonly
SUBTYPE_User BSON type
Static
Readonly
SUBTYPE_UUID BSON type
Static
Readonly
SUBTYPE_Deprecated UUID BSON type
Please use SUBTYPE_UUID
Reads length bytes starting at position.
read from the given position in the Binary.
the number of bytes to read.
Returns the value of this binary as a string.
Optional
asRaw: booleanWill skip converting to a string
Optional
This is handy when calling this function conditionally for some key value pairs and not others
Writes a buffer or string to the binary.
a string or buffer to be written to the Binary BSON object.
specify the binary of where to write the content.
Static
createStatic
createGenerated using TypeDoc
A class representation of the BSON Binary type.