Partager via

Guid class

  • Référence
Paquet:
@microsoft/sp-core-library

Cette classe représente un identificateur global unique, comme décrit par IETF RFC 4122.

Remarques

La chaîne d’entrée est normalisée et validée, ce qui fournit des garanties importantes qui simplifient le code qui fonctionne avec le GUID. Cette classe fournit également une prise en charge de base pour la génération d’un GUID pseudo-aléatoire. Toutefois, sachez que l’unicité dépend de la fonction du Math.random() navigateur et peut ne pas convenir à certaines applications.

Pour plus d’informations, consultez RFC4122 .

Propriétés

empty

Renvoie une nouvelle instance Guid vide.

Méthodes

equals(guid)

Comparer cette instance à une autre instance Guid
isValid(guid)

Indique si un GUID est valide, c’est-à-dire s’il est correctement analysé par Guid.tryParse(). Cette fonction est moins chère que parce qu’elle Guid.tryParse() ne construit pas d’objet GUID.
newGuid(randomNumberGenerator)

Retourne un nouveau GUID instance avec un GUID généré de façon pseudo-aléatoire, selon l’algorithme UUID version 4 de RFC 4122.
parse(guidString)

Analyse la chaîne d’entrée pour créer un nouvel objet Guid. Si la chaîne ne peut pas être analysée, une erreur est générée.
toString()

Retourne une représentation sous forme de chaîne du GUID
tryParse(guid)

Tente d’analyser la chaîne d’entrée pour créer un nouvel objet Guid. Si la chaîne ne peut pas être analysée, « Undefined » est renvoyé.

Détails de la propriété

empty

Renvoie une nouvelle instance Guid vide.

static readonly empty: Guid;

Valeur de propriété

Guid

Détails de la méthode

equals(guid)

Comparer cette instance à une autre instance Guid

equals(guid: Guid): boolean;

Paramètres

guid
Guid

Retours

boolean

True si cette instance et l’objet Guid spécifié représentent la même valeur.

isValid(guid)

Indique si un GUID est valide, c’est-à-dire s’il est correctement analysé par Guid.tryParse(). Cette fonction est moins chère que parce qu’elle Guid.tryParse() ne construit pas d’objet GUID.

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

Paramètres

guid

string | undefined | null

Chaîne d’entrée.

Retours

boolean

« True » si l’instance Guid est valide.

newGuid(randomNumberGenerator)

Retourne un nouveau GUID instance avec un GUID généré de façon pseudo-aléatoire, selon l’algorithme UUID version 4 de RFC 4122.

static newGuid(randomNumberGenerator?: IRandomNumberGenerator): Guid;

Paramètres

randomNumberGenerator
IRandomNumberGenerator

Retours

Guid

Un nouvel objet Guid unique

parse(guidString)

Analyse la chaîne d’entrée pour créer un nouvel objet Guid. Si la chaîne ne peut pas être analysée, une erreur est générée.

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

Paramètres

guidString

string | undefined | null

Chaîne d’entrée.

Retours

Guid

Un objet Guid valide

Remarques

Exemples de syntaxes acceptées par cette fonction :

  • "d5369f3bbd7a412a9c0f7f0650bb5489"

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

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

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

toString()

Retourne une représentation sous forme de chaîne du GUID

toString(): string;

Retours

string

La valeur GUID hexadécimale en minuscules sans accolades.

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

tryParse(guid)

Tente d’analyser la chaîne d’entrée pour créer un nouvel objet Guid. Si la chaîne ne peut pas être analysée, « Undefined » est renvoyé.

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

Paramètres

guid

string | undefined | null

Chaîne d’entrée.

Retours

Guid | undefined

L’objet Guid, ou « Undefined » si la chaîne n’a pas pu être analysée.

Remarques

Exemples de syntaxes acceptées par cette fonction :

  • "d5369f3bbd7a412a9c0f7f0650bb5489"

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

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

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