类 UUID

BSON UUID 类型的类表示形式。

层次结构（查看完整）

构造函数

构造函数

属性

_bsontype 缓冲 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 缓存十六进制string

访问器

id

方法

等于 检查 长度 PUT 读 转换为二进制 为十六进制string toJSON 为字符串 toUUID 值 写 从十六进制 创建string 生成 有效

构造函数

构造函数

  • 新的 UUID(输入?): UUID

  • 创建 UUID 类型

    参数

    • Optional 输入： string | UUID |单位8数组

      可以是 32 或 36 字符的十六进制string （排除/包含破折号）或 16 字节二进制缓冲区。

    返回UUID

属性

_bsontype

_bsontype: "Binary"

缓冲

缓冲: Uint8Array

Position

Position: 数字

sub_type

sub_type: 数字

Static Readonly BUFFER_SIZE

BUFFER_SIZE: 256 = 256

初始缓冲区默认大小

Static Readonly SUBTYPE_ BYTE_ ARRAY

SUBTYPE_ BYTE_ ARRAY: 2 = 2

字节数组BSON类型

Static Readonly SUBTYPE_COLUMN

SUBTYPE_COLUMN: 7 = 7

列BSON类型

Static Readonly SUBTYPE_DEFAULT

SUBTYPE_DEFAULT: 0 = 0

默认BSON类型

Static Readonly SUBTYPE_ENCRYPTED

SUBTYPE_ENCRYPTED: 6 = 6

加密 BSON 类型

Static Readonly SUBTYPE_FUNCTION

SUBTYPE_FUNCTION: 1 = 1

函数BSON类型

Static Readonly SUBTYPE_ MD5

SUBTYPE_ MD5: 5 = 5

MD 5 BSON类型

Static Readonly SUBTYPE_ USER_ DEFINED

SUBTYPE_ USER_ DEFINED: 128 = 128

用户BSON类型

Static Readonly SUBTYPE_ UUID

SUBTYPE_ UUID: 4 = 4

UUID BSON 类型

Static Readonly SUBTYPE_ UUID_ OLD

SUBTYPE_ UUID_ OLD: 3 = 3

已弃用的 UUID BSON类型

已弃用

请使用 SUBTYPE_UUID

Static 缓存十六进制string

缓存十六进制string: 布尔

访问器

id

  • get id(): Uint8Array

  • UUID 字节

    返回Uint 8数组

方法

等于

  • 等于(otherId): 布尔

  • 比较此 UUID 与otherID的相等性。

    参数

    • otherId : string | UUID |单位8数组

      要比较的 UUID实例。

    返回布尔值

检查

  • 检查(): 字符串

  • 返回字符串

长度

  • 长度(): 数字

  • 二进制序列的长度

    返回数字

PUT

  • PUT(byteValue): void

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

    参数

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

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

    返回void

读

  • 读(位置, 长度): BinarySequence

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

    参数

    • 位置：数字

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

    • length : number

      要读取的字节数。

    返回BinarySequence

转换为二进制

  • 转换为二进制(): 二进制文件

  • 从当前 UUID 创建二进制实例。

    返回二进制

为十六进制string

  • 为十六进制string(includeDashes?): 字符串

  • ID以32 或 字符的十六进制 表示形式返回 UUID36 string，不包括/包含破折号（默认以36 字符破折号分隔）

    参数

    • Optional includeDashes : boolean

      string是否应排除破折号分隔符。

    返回字符串

toJSON

  • toJSON(): 字符串

  • 将ID转换为其JSON string表示形式。 36 字符（包括破折号）的十六进制string ，格式如下：xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx

    返回字符串

为字符串

  • 为字符串(编码?): 字符串

  • 将ID转换为 36 字符（包括破折号）的十六进制string ，除非指定了编码。

    参数

    • Optional 编码： string

    返回字符串

toUUID

  • toUUID(): UUID

  • 返回UUID

值

  • 值(asRaw?): 字符串 | BinarySequence

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

    参数

    • Optional asRaw : boolean

      将跳过转换为string

    返回string | BinarySequence

    备注

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

写

  • 写(序列 (sequence)、 偏移量 (offset ) ) : void

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

    参数

    • 序列： string | BinarySequence

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

    • offset : number

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

    返回void

Static 从十六进制 创建string

  • 从十六进制 创建string(十六进制字符串): UUID

  • 从 UUID 的十六进制string表示创建 UUID。

    参数

    • hexString : string

      32 或 36 字符的十六进制string （排除/包含破折号）。

    返回UUID

Static 生成

  • 生成(): Uint8Array

  • 生成包含 av 4 uuid 的已填充缓冲区

    返回Uint 8数组

Static 有效

  • 有效(输入): 布尔

  • 检查值是否为有效的BSON UUID

    参数

    • 输入： string | UUID |单位8数组

      要验证的 UUID、 string或缓冲区。

    返回布尔值

设置

成员可见性

主题

在此页面上

使用TypeDoc生成