Binary | mongodb (original) (raw)

Hierarchy (view full)

• BSONValue
  • Binary
    * UUID

Index

Constructors

constructor

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

• Returns Binary

Properties

buffer

buffer: Uint8Array

position

position: number

sub_type

sub_type: number

Static ReadonlyBUFFER_SIZE

BUFFER_SIZE: 256 = 256

Static ReadonlySUBTYPE_BYTE_ARRAY

SUBTYPE_BYTE_ARRAY: 2 = 2

Static ReadonlySUBTYPE_COLUMN

SUBTYPE_COLUMN: 7 = 7

Static ReadonlySUBTYPE_DEFAULT

SUBTYPE_DEFAULT: 0 = 0

Static ReadonlySUBTYPE_ENCRYPTED

SUBTYPE_ENCRYPTED: 6 = 6

Static ReadonlySUBTYPE_FUNCTION

SUBTYPE_FUNCTION: 1 = 1

Static ReadonlySUBTYPE_MD5

SUBTYPE_MD5: 5 = 5

Static ReadonlySUBTYPE_SENSITIVE

SUBTYPE_SENSITIVE: 8 = 8

Static ReadonlySUBTYPE_USER_DEFINED

SUBTYPE_USER_DEFINED: 128 = 128

Static ReadonlySUBTYPE_UUID

SUBTYPE_UUID: 4 = 4

Static ReadonlySUBTYPE_UUID_OLD

SUBTYPE_UUID_OLD: 3 = 3

Static ReadonlySUBTYPE_VECTOR

SUBTYPE_VECTOR: 9 = 9

Static ReadonlyVECTOR_TYPE

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

Accessors

_bsontype

• get _bsontype(): "Binary"

• Returns "Binary"

Methods

inspect

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

• Parameters

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

Returns string

length

• length(): number

• Returns number

put

• put(byteValue): void

• Parameters

  • byteValue:
    | string
    | number
    | Uint8Array
    | number[]

Returns void

read

• read(position, length): Uint8Array

• Parameters

  • position: number
  • length: number

Returns Uint8Array

toBits

• toBits(): Int8Array

• Returns Int8Array

toFloat32Array

• toFloat32Array(): Float32Array

• Returns Float32Array

toInt8Array

• toInt8Array(): Int8Array

• Returns Int8Array

toJSON

• toJSON(): string

• Returns string

toPackedBits

• toPackedBits(): Uint8Array

• Returns Uint8Array

toString

• toString(encoding?): string

• Parameters

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

Returns string

toUUID

• toUUID(): UUID

• Returns UUID

value

• value(): Uint8Array

• Returns Uint8Array

write

• write(sequence, offset): void

• Returns void

StaticcreateFromBase64

• createFromBase64(base64, subType?): Binary

• Parameters

  • base64: string
  • OptionalsubType: number

Returns Binary

StaticcreateFromHexString

• createFromHexString(hex, subType?): Binary

• Parameters

  • hex: string
  • OptionalsubType: number

Returns Binary

StaticfromBits

• fromBits(bits): Binary

• Parameters

  • bits: ArrayLike<number>

Returns Binary

StaticfromFloat32Array

• fromFloat32Array(array): Binary

• Parameters

  • array: Float32Array

Returns Binary

StaticfromInt8Array

• fromInt8Array(array): Binary

• Parameters

  • array: Int8Array

Returns Binary

StaticfromPackedBits

• fromPackedBits(array, padding?): Binary

• Parameters

  • array: Uint8Array
  • Optionalpadding: number

Returns Binary