Guid class

パッケージ:
@microsoft/sp-core-library

このクラスは、IETF RFC 4122 で説明されているように、グローバルに一意の識別子を表します。

注釈

入力文字列は正規化および検証され、GUID で動作する他のコードを簡略化する重要な保証が提供されます。 このクラスは、擬似ランダム GUID を生成するための基本的なサポートも提供します。ただし、一意性はブラウザーの Math.random() 機能に依存し、一部のアプリケーションには適していない可能性があることに注意してください。

詳細については 、「RFC4122 」を参照してください。

プロパティ

empty

新しい空の Guid のインスタンスを返します。

メソッド

equals(guid)

このインスタンスを別の GUID インスタンスと比較します
isValid(guid)

GUID が有効かどうかを示します。つまり、GUID が Guid.tryParse()によって正常に解析されるかどうかを示します。 この関数は Guid オブジェクトを構築しないため、 Guid.tryParse() よりも安価です。
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 が Guid.tryParse()によって正常に解析されるかどうかを示します。 この関数は Guid オブジェクトを構築しないため、 Guid.tryParse() よりも安価です。

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

中かっこのない、小文字の 16 進数の 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)/"