Compartilhar via

Guid class

  • Referência
Pacote:
@microsoft/sp-core-library

Essa classe representa um identificador global exclusivo, como descrito pela IETF RFC 4122.

Comentários

A cadeia de caracteres de entrada é normalizada e validada, o que fornece as garantias importantes que simplificam outro código que funciona com o GUID. Esta classe também fornece suporte básico para gerar um GUID pseudo-aleatório; no entanto, tenha em atenção que a exclusividade depende da função do Math.random() browser e pode não ser adequada para algumas aplicações.

Consulte RFC4122 para obter mais informações.

Propriedades

empty

Retorna uma nova instância Guid vazia.

Métodos

equals(guid)

Comparar esta instância a outra instância Guid
isValid(guid)

Indica se um GUID é válido, ou seja, se seria analisado com êxito por Guid.tryParse(). Esta função é mais barata do que Guid.tryParse() porque não constrói um objeto Guid.
newGuid(randomNumberGenerator)

Devolve uma nova instância guid com um GUID gerado pseudo-aleatoriamente, de acordo com o algoritmo UUID da versão 4 do RFC 4122.
parse(guidString)

Analisa a cadeia de caracteres de entrada para construir um novo objeto Guid. Se a cadeia de caracteres não puder ser analisada, será gerado um erro.
toString()

Devolve uma representação de cadeia do GUID
tryParse(guid)

Tenta analisar a cadeia de caracteres de entrada para construir um novo objeto Guid. Se a cadeia de caracteres não puder ser analisada, será retornado indefinido.

Detalhes da propriedade

empty

Retorna uma nova instância Guid vazia.

static readonly empty: Guid;

Valor da propriedade

Guid

Detalhes do método

equals(guid)

Comparar esta instância a outra instância Guid

equals(guid: Guid): boolean;

Parâmetros

guid
Guid

Retornos

boolean

True se essa instância e o objeto Guid especificado representam o mesmo valor.

isValid(guid)

Indica se um GUID é válido, ou seja, se seria analisado com êxito por Guid.tryParse(). Esta função é mais barata do que Guid.tryParse() porque não constrói um objeto Guid.

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

Parâmetros

guid

string | undefined | null

A cadeia de caracteres de entrada.

Retornos

boolean

true, se o Guid for válido.

newGuid(randomNumberGenerator)

Devolve uma nova instância guid com um GUID gerado pseudo-aleatoriamente, de acordo com o algoritmo UUID da versão 4 do RFC 4122.

static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;

Parâmetros

randomNumberGenerator
IRandomNumberGenerator

Retornos

Guid

Um novo objeto Guid exclusivo

parse(guidString)

Analisa a cadeia de caracteres de entrada para construir um novo objeto Guid. Se a cadeia de caracteres não puder ser analisada, será gerado um erro.

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

Parâmetros

guidString

string | undefined | null

A cadeia de caracteres de entrada.

Retornos

Guid

Um objeto Guid válido

Comentários

Sintaxes de exemplo aceites por esta função:

  • "d5369f3bbd7a412a9c0f7f0650bb5489"

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

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

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

toString()

Devolve uma representação de cadeia do GUID

toString(): string;

Retornos

string

O valor GUID em minúsculas hexadecimais sem chaves.

Exemplo: 'd5369f3b-bd7a-412a-9c0f-7f0650bb5489'

tryParse(guid)

Tenta analisar a cadeia de caracteres de entrada para construir um novo objeto Guid. Se a cadeia de caracteres não puder ser analisada, será retornado indefinido.

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

Parâmetros

guid

string | undefined | null

A cadeia de caracteres de entrada.

Retornos

Guid | undefined

O objeto Guid ou indefinido se a cadeia de caracteres não puder ser analisada.

Comentários

Sintaxes de exemplo aceites por esta função:

  • "d5369f3bbd7a412a9c0f7f0650bb5489"

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

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

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