Class Binary

constructor

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

• 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.

  Parameters

  • Optional buffer: string | BinarySequence

    a buffer object containing the binary data.

  • Optional subType: number

    the option binary type.

  Returns Binary

buffer

position

sub_type

Static Readonly BUFFER_SIZE

Static Readonly SUBTYPE_BYTE_ARRAY

Static Readonly SUBTYPE_COLUMN

Static Readonly SUBTYPE_DEFAULT

Static Readonly SUBTYPE_ENCRYPTED

Static Readonly SUBTYPE_FUNCTION

Static Readonly SUBTYPE_MD5

Static Readonly SUBTYPE_USER_DEFINED

Static Readonly SUBTYPE_UUID

Static Readonly SUBTYPE_UUID_OLD

_bsontype

• get _bsontype(): "Binary"

• Returns "Binary"

inspect

• inspect(): string

• 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 | number[]

    a single byte we wish to write.

  Returns void

read

• read(position, length): BinarySequence

• Reads 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 BinarySequence

toJSON

• toJSON(): string

• Returns string

toString

• toString(encoding?): string

• Parameters

  • Optional encoding: "base64" | "hex" | "utf8" | "utf-8"

  Returns string

toUUID

• toUUID(): UUID

• Returns UUID

value

• value(asRaw?): string | BinarySequence

• Returns the value of this binary as a string.

  Parameters

  • Optional asRaw: boolean

    Will skip converting to a string

  Returns string | BinarySequence

  Remarks

  This is handy when calling this function conditionally for some key value pairs and not others

write

• write(sequence, offset): void

• Writes a buffer or string to the binary.

  Parameters

  • sequence: string | 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

Static createFromBase64

• createFromBase64(base64, subType?): Binary

• Creates an Binary instance from a base64 string

  Parameters

  • base64: string

  • Optional subType: number

  Returns Binary

Static createFromHexString

• createFromHexString(hex, subType?): Binary

• Creates an Binary instance from a hex digit string

  Parameters

  • hex: string

  • Optional subType: number

  Returns Binary