Class Binary

A class representation of the BSON Binary type.BSON二进制类型的类表示形式。

Hierarchy

Constructors

  • Create a new Binary instance.创建一个新的二进制实例。

    Parameters

    • Optional buffer: BinarySequence

      a buffer object containing the binary data.包含二进制数据的缓冲区对象。

    • Optional subType: number

      the option binary type.选项二进制类型。

    Returns Binary

Properties

buffer: Uint8Array
position: number
sub_type: number
BUFFER_SIZE: 256 = 256

Initial buffer default size初始缓冲区默认大小

SUBTYPE_BYTE_ARRAY: 2 = 2

Byte Array BSON type字节数组BSON类型

SUBTYPE_COLUMN: 7 = 7

Column BSON typeBSON列类型

SUBTYPE_DEFAULT: 0 = 0

Default BSON type默认BSON类型

SUBTYPE_ENCRYPTED: 6 = 6

Encrypted BSON type加密BSON类型

SUBTYPE_FUNCTION: 1 = 1

Function BSON type函数BSON类型

SUBTYPE_MD5: 5 = 5

MD5 BSON typeMD5 BSON类型

SUBTYPE_USER_DEFINED: 128 = 128

User BSON type用户BSON类型

SUBTYPE_UUID: 4 = 4

UUID BSON type类型

SUBTYPE_UUID_OLD: 3 = 3

Deprecated UUID BSON type

Deprecated

Please use SUBTYPE_UUID

Accessors

  • get _bsontype(): "Binary"
  • Returns "Binary"

Methods

  • Returns string

  • the length of the binary sequence二进制序列的长度

    Returns number

  • Updates this binary with byte_value.使用byte_value更新此二进制文件。

    Parameters

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

      a single byte we wish to write.我们希望写入的单个字节。

    Returns void

  • 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

  • Returns string

  • Parameters

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

    Returns string

  • Returns UUID

  • returns a view of the binary value as a Uint8Array以Uint8Array的形式返回二进制值的视图

    Returns Uint8Array

  • Writes a buffer to the binary.将缓冲区写入二进制文件。

    Parameters

    • sequence: BinarySequence

      a string or buffer to be written to the Binary BSON object.要写入Binary BSON对象的字符串或缓冲区。

    • offset: number

      specify the binary of where to write the content.指定写入内容的二进制位置。

    Returns void

  • Creates an Binary instance from a base64 string从base64字符串创建二进制实例

    Parameters

    • base64: string
    • Optional subType: number

    Returns Binary

  • Creates an Binary instance from a hex digit string从十六进制字符串创建二进制实例

    Parameters

    • hex: string
    • Optional subType: number

    Returns Binary

Generated using TypeDoc