通过

Guid class

  • 参考
包:
@microsoft/sp-core-library

该类表示全局唯一标识符，如 IETF RFC 4122 所述。

注解

对输入字符串进行规范化和验证，这为简化使用 GUID 的其他代码提供了重要保证。 此类还提供生成伪随机 GUID 的基本支持;但是，请注意，唯一性取决于浏览器的 Math.random() 函数，可能不适合某些应用程序。

有关详细信息 ，请参阅RFC4122 。

属性

empty

返回一个新的空 Guid 实例。

方法

equals(guid)

将此实例与其他 Guid 实例比较
isValid(guid)

指示 GUID 是否有效，即 是否由 成功分析 Guid.tryParse()。 此函数比 Guid.tryParse() 它便宜，因为它不构造 Guid 对象。
newGuid(randomNumberGenerator)

根据 RFC 4122 中的版本 4 UUID 算法，返回具有伪随机生成的 GUID 的新 Guid 实例。
parse(guidString)

分析输入字符串以构建一个新的 Guid 对象。 如果无法分析字符串，则会引发错误。
toString()

返回 GUID 的字符串表示形式
tryParse(guid)

尝试分析输入字符串以构建新的 Guid 对象。 如果无法分析字符串，则返回 undefined。

属性详细信息

empty

返回一个新的空 Guid 实例。

static readonly empty: Guid;

属性值

Guid

方法详细信息

equals(guid)

将此实例与其他 Guid 实例比较

equals(guid: Guid): boolean;

参数

guid
Guid

返回

boolean

如果此实例和指定的 Guid 对象表示相同的值，则为 true。

isValid(guid)

指示 GUID 是否有效，即 是否由 成功分析 Guid.tryParse()。 此函数比 Guid.tryParse() 它便宜，因为它不构造 Guid 对象。

static isValid(guid: string | undefined | null): boolean;

参数

guid

string | undefined | null

输入字符串。

返回

boolean

如果 Guid 有效，则为 true。

newGuid(randomNumberGenerator)

根据 RFC 4122 中的版本 4 UUID 算法，返回具有伪随机生成的 GUID 的新 Guid 实例。

static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;

参数

randomNumberGenerator
IRandomNumberGenerator

返回

Guid

新的唯一 Guid 对象

parse(guidString)

分析输入字符串以构建一个新的 Guid 对象。 如果无法分析字符串，则会引发错误。

static parse(guidString: string | undefined | null): Guid;

参数

guidString

string | undefined | null

输入字符串。

返回

Guid

有效的 Guid 对象

注解

此函数接受的示例语法：

  • "d5369f3bbd7a412a9c0f7f0650bb5489"

  • "d5369f3b-bd7a-412a-9c0f-7f0650bb5489"

  • "{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"

  • "/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"

toString()

返回 GUID 的字符串表示形式

toString(): string;

返回

string

不含括号并以小写的十六进制表示的 GUID 值。

例如：'d5369f3b-bd7a-412a-9c0f-7f0650bb5489'

tryParse(guid)

尝试分析输入字符串以构建新的 Guid 对象。 如果无法分析字符串，则返回 undefined。

static tryParse(guid: string | undefined | null): Guid | undefined;

参数

guid

string | undefined | null

输入字符串。

返回

Guid | undefined

Guid 对象，如果字符串无法分析则为 undefined。

注解

此函数接受的示例语法：

  • "d5369f3bbd7a412a9c0f7f0650bb5489"

  • "d5369f3b-bd7a-412a-9c0f-7f0650bb5489"

  • "{d5369f3b-bd7a-412a-9c0f-7f0650bb5489}"

  • "/Guid(d5369f3b-bd7a-412a-9c0f-7f0650bb5489)/"