Class Binary

constructor

• new Binary(buffer?, subType?): Binary

• Create a new Binary instance.

  Parameters

  • Optionalbuffer: BinarySequence

    a buffer object containing the binary data.
  • OptionalsubType: number

    the option binary type.

  Returns Binary

buffer

binary	::= int32 subtype (byte*)
Copy

binary	::= int32 unsigned_byte(2) int32 (byte*)
Copy

position

sub_type

Static ReadonlyBUFFER_SIZE

Static ReadonlySUBTYPE_BYTE_ARRAY

Static ReadonlySUBTYPE_COLUMN

Static ReadonlySUBTYPE_DEFAULT

Static ReadonlySUBTYPE_ENCRYPTED

Static ReadonlySUBTYPE_FUNCTION

Static ReadonlySUBTYPE_MD5

Static ReadonlySUBTYPE_SENSITIVE

Static ReadonlySUBTYPE_USER_DEFINED

Static ReadonlySUBTYPE_UUID

Static ReadonlySUBTYPE_UUID_OLD

Static ReadonlySUBTYPE_VECTOR

Static ReadonlyVECTOR_TYPE

_bsontype

• get _bsontype(): "Binary"

• Returns "Binary"

inspect

• inspect(depth?, options?, inspect?): string

• Prints a human-readable string of BSON value information If invoked manually without node.js.inspect function, this will default to a modified JSON.stringify

  Parameters

  • Optionaldepth: number
  • Optionaloptions: unknown
  • Optionalinspect: InspectFn

  Returns string

length

• length(): number

• the length of the binary sequence

  Returns number

put

• put(byteValue): void

• Updates this binary with byte_value.

  Parameters

  • byteValue:
        | string
        | number
        | Uint8Array<ArrayBufferLike>
        | number[]

    a single byte we wish to write.

  Returns void

read

• read(position, length): Uint8Array<ArrayBufferLike>

• Returns a view of length bytes starting at position.

  Parameters

  • position: number

    read from the given position in the Binary.
  • length: number

    the number of bytes to read.

  Returns Uint8Array<ArrayBufferLike>

toBits

• toBits(): Int8Array<ArrayBufferLike>

• If this Binary represents a Packed bit Vector (binary.buffer[0] === Binary.VECTOR_TYPE.PackedBit), returns a copy of the bit unpacked into a new Int8Array.

  Use toPackedBits to get the bits still in packed form.

  If the Binary is not a Vector, or the datatype is not PackedBit, an error is thrown.

  Returns Int8Array<ArrayBufferLike>

toFloat32Array

• toFloat32Array(): Float32Array<ArrayBufferLike>

• If this Binary represents a Float32 Vector (binary.buffer[0] === Binary.VECTOR_TYPE.Float32), returns a copy of the bytes in a new Float32Array.

  If the Binary is not a Vector, or the datatype is not Float32, an error is thrown.

  Returns Float32Array<ArrayBufferLike>

toInt8Array

• toInt8Array(): Int8Array<ArrayBufferLike>

• If this Binary represents a Int8 Vector (binary.buffer[0] === Binary.VECTOR_TYPE.Int8), returns a copy of the bytes in a new Int8Array.

  If the Binary is not a Vector, or the datatype is not Int8, an error is thrown.

  Returns Int8Array<ArrayBufferLike>

toJSON

• toJSON(): string

• Returns string

toPackedBits

• toPackedBits(): Uint8Array<ArrayBufferLike>

• If this Binary represents packed bit Vector (binary.buffer[0] === Binary.VECTOR_TYPE.PackedBit), returns a copy of the bytes that are packed bits.

  Use toBits to get the unpacked bits.

  If the Binary is not a Vector, or the datatype is not PackedBit, an error is thrown.

  Returns Uint8Array<ArrayBufferLike>

toString

• toString(encoding?): string

• Returns a string representation of an object.

  Parameters

  • Optionalencoding:
        | "utf8"
        | "utf-8"
        | "base64"
        | "hex"

  Returns string

toUUID

• toUUID(): UUID

• Returns UUID

value

• value(): Uint8Array<ArrayBufferLike>

• returns a view of the binary value as a Uint8Array

  Returns Uint8Array<ArrayBufferLike>

write

• write(sequence, offset): void

• Writes a buffer to the binary.

  Parameters

  • sequence: BinarySequence

    a string or buffer to be written to the Binary BSON object.
  • offset: number

    specify the binary of where to write the content.

  Returns void

StaticcreateFromBase64

• createFromBase64(base64, subType?): Binary

• Creates an Binary instance from a base64 string

  Parameters

  • base64: string
  • OptionalsubType: number

  Returns Binary

StaticcreateFromHexString

• createFromHexString(hex, subType?): Binary

• Creates an Binary instance from a hex digit string

  Parameters

  • hex: string
  • OptionalsubType: number

  Returns Binary

StaticfromBits

• fromBits(bits): Binary

• Constructs a Binary representing an Packed Bit Vector.

  Parameters

  • bits: ArrayLike<number>

  Returns Binary

StaticfromFloat32Array

• fromFloat32Array(array): Binary

• Constructs a Binary representing an Float32 Vector.

  Parameters

  • array: Float32Array<ArrayBufferLike>

  Returns Binary

StaticfromInt8Array

• fromInt8Array(array): Binary

• Constructs a Binary representing an Int8 Vector.

  Parameters

  • array: Int8Array<ArrayBufferLike>

    The array to store as a view on the Binary class

  Returns Binary

StaticfromPackedBits

• fromPackedBits(array, padding?): Binary

• Constructs a Binary representing a packed bit Vector.

  Use fromBits to pack an array of 1s and 0s.

  Parameters

  • array: Uint8Array<ArrayBufferLike>
  • Optionalpadding: number

  Returns Binary