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)	Возвращает новый экземпляр Guid с псевдослучайным идентификатором GUID в соответствии с алгоритмом UUID версии 4 из RFC 4122.
parse(guidString)	Анализирует входную строку для создания объекта Guid. Если проанализировать строку не удается, возникает ошибка.
toString()	Возвращает строковое представление GUID.
tryParse(guid)	Пытается проанализировать входную строку для создания объекта Guid. Если проанализировать строку не удается, возвращается неопределенное значение.

Сведения о свойстве

empty

Возвращает новый пустой экземпляр Guid.

static readonly empty: Guid;

Значение свойства

Guid

Сведения о методе

equals(guid)

Сравнение этого экземпляра с другим экземпляром Guid

equals(guid: Guid): boolean;

Параметры

guid

Guid

Возвращаемое значение

boolean

Значение true, если этот экземпляр и указанный объект Guid представляют одно и то же значение.

isValid(guid)

Указывает, является ли GUID допустимым, т. е. будет ли он успешно проанализирован с помощью Guid.tryParse(). Эта функция дешевле, чем Guid.tryParse() потому, что она не создает объект Guid.

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

Параметры

guid

string | undefined | null

Входная строка.

Возвращаемое значение

boolean

Значение true, если объект Guid является допустимым.

newGuid(randomNumberGenerator)

Возвращает новый экземпляр Guid с псевдослучайным идентификатором GUID в соответствии с алгоритмом UUID версии 4 из RFC 4122.

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. Если проанализировать строку не удается, возвращается неопределенное значение.

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

Параметры

guid

string | undefined | null

Входная строка.

Возвращаемое значение

Guid | undefined

Объект Guid или неопределенное значение (если проанализировать строку не удалось).

Комментарии

Примеры синтаксисов, принятых этой функцией:

• "d5369f3bbd7a412a9c0f7f0650bb5489"

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

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

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