BSON二进制类型的类表示。

层次结构(查看完整

构造函数

  • 创建一个新的 Binary实例。

    此构造函数可以接受string作为其第一个参数。 在本例中,该string将使用 ISO-8859-1(而不是UTF-8)进行编码。 这几乎可以肯定不是您想要的。 使用 new Binary(Buffer.from(string)) 代替,首先使用 UTF-8 将string转换为缓冲区。

    参数

    • Optional 缓冲区string | BinarySequence

      包含二进制数据的缓冲区对象。

    • Optional subType : number

      选项二进制类型。

    返回二进制

属性

_bsontype: "Binary"
缓冲: Uint8Array
Position: 数字
sub_type: 数字
BUFFER_SIZE: 256 = 256

初始缓冲区默认大小

SUBTYPE_ BYTE_ ARRAY: 2 = 2

字节数组BSON类型

SUBTYPE_COLUMN: 7 = 7

列BSON类型

SUBTYPE_DEFAULT: 0 = 0

默认BSON类型

SUBTYPE_ENCRYPTED: 6 = 6

加密 BSON 类型

SUBTYPE_FUNCTION: 1 = 1

函数BSON类型

SUBTYPE_ MD5: 5 = 5

MD 5 BSON类型

SUBTYPE_ USER_ DEFINED: 128 = 128

用户BSON类型

SUBTYPE_ UUID: 4 = 4

UUID BSON 类型

SUBTYPE_ UUID_ OLD: 3 = 3

已弃用的 UUID BSON类型

已弃用

请使用 SUBTYPE_UUID

方法

  • 返回字符串

  • 二进制序列的长度

    返回数字

  • 使用 byte_value 更新此二进制文件。

    参数

    • byteValue : string |编号| number [] |单位8数组

      我们希望写入的单个字节。

    返回void

  • 读取从位置开始的length字节。

    参数

    • 位置数字

      从二进制文件中的给定位置读取。

    • length : number

      要读取的字节数。

    返回BinarySequence

  • 返回字符串

  • 参数

    • Optional format : string

    返回字符串

  • 返回UUID

  • 以string形式返回该二进制文件的值。

    参数

    • Optional asRaw : boolean

      将跳过转换为string

    返回string | BinarySequence

    备注

    当有条件地为某些键值对而不是其他键值对调用此函数时,这非常方便

  • 将缓冲区或string写入二进制文件。

    参数

    • 序列string | BinarySequence

      string要写入二进制BSON 对象的 或缓冲区。

    • offset : number

      指定在何处写入内容的二进制文件。

    返回void

使用TypeDoc生成