类 Binary

constructor

• new Binary(buffer?: string | BinarySequence, subType?: number): 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.

  参数

  • 可选buffer: string | BinarySequence

    a buffer object containing the binary data.

  • 可选subType: number

    the option binary type.

  返回 Binary

buffer

position

sub_type

静态 只读BUFFER_SIZE

静态 只读SUBTYPE_BYTE_ARRAY

静态 只读SUBTYPE_COLUMN

静态 只读SUBTYPE_DEFAULT

静态 只读SUBTYPE_ENCRYPTED

静态 只读SUBTYPE_FUNCTION

静态 只读SUBTYPE_MD5

静态 只读SUBTYPE_USER_DEFINED

静态 只读SUBTYPE_UUID

静态 只读SUBTYPE_UUID_OLD

_bsontype

• get _bsontype(): "Binary"

  返回 "Binary"

inspect

• inspect(): string

  返回 string

length

• length(): number

  the length of the binary sequence

  返回 number

put

• put(byteValue: string | number | number[] | Uint8Array<ArrayBufferLike>): void

  Updates this binary with byte_value.

  参数

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

    a single byte we wish to write.

  返回 void

read

• read(position: number, length: number): BinarySequence

  Reads length bytes starting at position.

  参数

  • position: number

    read from the given position in the Binary.

  • length: number

    the number of bytes to read.

  返回 BinarySequence

toJSON

• toJSON(): string

  返回 string

toString

• toString(encoding?: "utf8" | "utf-8" | "base64" | "hex"): string

  Returns a string representation of an object.

  参数

  • 可选encoding: "utf8" | "utf-8" | "base64" | "hex"

  返回 string

toUUID

• toUUID(): UUID

  返回 UUID

value

• value(asRaw?: boolean): string | BinarySequence

  Returns the value of this binary as a string.

  参数

  • 可选asRaw: boolean

    Will skip converting to a string

  返回 string | BinarySequence

  备注

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

write

• write(sequence: string | BinarySequence, offset: number): void

  Writes a buffer or string to the binary.

  参数

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

  返回 void

静态createFromBase64

• createFromBase64(base64: string, subType?: number): Binary

  Creates an Binary instance from a base64 string

  参数

  • base64: string
  • 可选subType: number

  返回 Binary

静态createFromHexString

• createFromHexString(hex: string, subType?: number): Binary

  Creates an Binary instance from a hex digit string

  参数

  • hex: string
  • 可选subType: number

  返回 Binary