Class Binary

A class representation of the BSON Binary type.

Hierarchy (view full)

Constructors

constructor

Properties

buffer position sub_type BUFFER_SIZE SUBTYPE_BYTE_ARRAY SUBTYPE_COLUMN SUBTYPE_DEFAULT SUBTYPE_ENCRYPTED SUBTYPE_FUNCTION SUBTYPE_MD5 SUBTYPE_SENSITIVE SUBTYPE_USER_DEFINED SUBTYPE_UUID SUBTYPE_UUID_OLD SUBTYPE_VECTOR VECTOR_TYPE

Accessors

_bsontype [bsonType]

Methods

inspect length put read toBits toFloat32Array toInt8Array toJSON toPackedBits toString toUUID value write createFromBase64 createFromHexString fromBits fromFloat32Array fromInt8Array fromPackedBits

Constructors

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

Properties

buffer

buffer: Uint8Array<ArrayBufferLike>

The bytes of the Binary value.

The format of a Binary value in BSON is defined as:

binary	::= int32 subtype (byte*)

This buffer is the "(byte*)" segment.

Unless the value is subtype 2, then deserialize will read the first 4 bytes as an int32 and set this to the remaining bytes.

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

See

https://bsonspec.org/spec.html

position

position: number

The Binary's buffer can be larger than the Binary's content. This property is used to determine where the content ends in the buffer.

sub_type

sub_type: number

The binary subtype.

Current defined values are:

  • unsigned_byte(0) Generic binary subtype
  • unsigned_byte(1) Function
  • unsigned_byte(2) Binary (Deprecated)
  • unsigned_byte(3) UUID (Deprecated)
  • unsigned_byte(4) UUID
  • unsigned_byte(5) MD5
  • unsigned_byte(6) Encrypted BSON value
  • unsigned_byte(7) Compressed BSON column
  • unsigned_byte(8) Sensitive
  • unsigned_byte(9) Vector
  • unsigned_byte(128) - unsigned_byte(255) User defined

Static ReadonlyBUFFER_SIZE

BUFFER_SIZE: 256 = 256

Initial buffer default size

Static ReadonlySUBTYPE_BYTE_ARRAY

SUBTYPE_BYTE_ARRAY: 2 = 2

Legacy default BSON Binary type

Deprecated

BSON Binary subtype 2 is deprecated in the BSON specification

Static ReadonlySUBTYPE_COLUMN

SUBTYPE_COLUMN: 7 = 7

Column BSON type

Static ReadonlySUBTYPE_DEFAULT

SUBTYPE_DEFAULT: 0 = 0

Default BSON type

Static ReadonlySUBTYPE_ENCRYPTED

SUBTYPE_ENCRYPTED: 6 = 6

Encrypted BSON type

Static ReadonlySUBTYPE_FUNCTION

SUBTYPE_FUNCTION: 1 = 1

Function BSON type

Static ReadonlySUBTYPE_MD5

SUBTYPE_MD5: 5 = 5

MD5 BSON type

Static ReadonlySUBTYPE_SENSITIVE

SUBTYPE_SENSITIVE: 8 = 8

Sensitive BSON type

Static ReadonlySUBTYPE_USER_DEFINED

SUBTYPE_USER_DEFINED: 128 = 128

User BSON type

Static ReadonlySUBTYPE_UUID

SUBTYPE_UUID: 4 = 4

UUID BSON type

Static ReadonlySUBTYPE_UUID_OLD

SUBTYPE_UUID_OLD: 3 = 3

Deprecated UUID BSON type

Deprecated

Please use SUBTYPE_UUID

Static ReadonlySUBTYPE_VECTOR

SUBTYPE_VECTOR: 9 = 9

Vector BSON type

Static ReadonlyVECTOR_TYPE

VECTOR_TYPE: Readonly<{
    Float32: 39;
    Int8: 3;
    PackedBit: 16;
}>

datatype of a Binary Vector (subtype: 9)

Accessors

_bsontype

  • get _bsontype(): "Binary"

  • Returns "Binary"

[bsonType]

  • get [bsonType](): this["_bsontype"]

  • Returns this["_bsontype"]

Methods

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

Settings
Member Visibility

On This Page
Constructors
Properties
Accessors
Methods