@azure/core-util package
インターフェイス
| AbortOptions |
中止コントローラーに関連するオプション。 |
| CreateAbortablePromiseOptions |
createAbortablePromise 関数のオプション。 |
| DelayOptions |
遅延メソッドのサポート中止機能のオプション |
型エイリアス
| AbortablePromiseBuilder |
中止できる Promise を返す関数を表します。 |
| EncodingType |
サポートされている文字エンコードの種類 |
| HttpMethods |
要求を行うときに使用する HTTP メソッドがサポートされています。 |
| UnknownObject |
プレーンな JS オブジェクトの汎用図形。 |
関数
関数の詳細
calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })
指数遅延とジッターを使用して再試行の遅延間隔を計算します。
function calculateRetryDelay(retryAttempt: number, config: { maxRetryDelayInMs: number, retryDelayInMs: number }): { retryAfterInMs: number }パラメーター
- retryAttempt
-
number
現在の再試行回数。
- config
-
{ maxRetryDelayInMs: number, retryDelayInMs: number }
指数再試行の構成。
戻り値
{ retryAfterInMs: number }
計算された再試行遅延を含むオブジェクト。
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })
最初の promise が解決されるとすぐに、残りの promise を中止する promise.race() ラッパー。
function cancelablePromiseRace<T>(abortablePromiseBuilders: AbortablePromiseBuilder<T[number]>[], options?: { abortSignal?: AbortSignalLike }): Promise<T[number]>パラメーター
- abortablePromiseBuilders
-
AbortablePromiseBuilder<T[number]>[]
- options
-
{ abortSignal?: AbortSignalLike }
戻り値
Promise<T[number]>
computeSha256Hash(string, "base64" | "hex")
SHA-256 ハッシュを生成します。
function computeSha256Hash(content: string, encoding: "base64" | "hex"): Promise<string>パラメーター
- content
-
string
ハッシュに含めるデータ。
- encoding
-
"base64" | "hex"
返されたハッシュに使用するテキスト エンコード。
戻り値
Promise<string>
computeSha256Hmac(string, string, "base64" | "hex")
SHA-256 HMAC 署名を生成します。
function computeSha256Hmac(key: string, stringToSign: string, encoding: "base64" | "hex"): Promise<string>パラメーター
- key
-
string
暗号化 HMAC ハッシュの生成に使用される base64 文字列として表される HMAC キー。
- stringToSign
-
string
署名するデータ。
- encoding
-
"base64" | "hex"
返された HMAC ダイジェストに使用するテキスト エンコード。
戻り値
Promise<string>
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)
中止可能な Promise を作成します。
function createAbortablePromise<T>(buildPromise: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, options?: CreateAbortablePromiseOptions): Promise<T>パラメーター
- buildPromise
-
(resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void
解決関数と拒否関数をパラメーターとして受け取る関数。
- options
- CreateAbortablePromiseOptions
中止可能な Promise のオプション。
戻り値
Promise<T>
中止できる約束。
delay(number, DelayOptions)
timeInMs ミリ秒後に promise を解決する setTimeout のラッパー。
function delay(timeInMs: number, options?: DelayOptions): Promise<void>パラメーター
- timeInMs
-
number
遅延するミリ秒数。
- options
- DelayOptions
遅延のオプション - 現在の中止オプション
戻り値
Promise<void>
timeInMs の後に解決される Promise
getErrorMessage(unknown)
エラー オブジェクトと考えられるものを考えると、可能であればメッセージを返します。 メッセージが見つからない場合は、文字列化されたバージョンの入力を返します。
function getErrorMessage(e: unknown): stringパラメーター
- e
-
unknown
try ブロックからスローされる内容
戻り値
string
エラー メッセージまたは入力の文字列
getRandomIntegerInclusive(number, number)
両方の境界を含む、下限と上限の間のランダムな整数値を返します。 これは Math.random を使用し、セキュリティで保護されていないことに注意してください。 任意の種類のセキュリティ目的でこれを使用する必要がある場合は、ランダムのより良いソースを見つけます。
function getRandomIntegerInclusive(min: number, max: number): numberパラメーター
- min
-
number
使用できる最小の整数値。
- max
-
number
使用できる最大の整数値。
戻り値
number
isDefined<T>(undefined | null | T)
何かが定義されているかどうかをチェックするヘルパー TypeGuard。
function isDefined<T>(thing: undefined | null | T): thingパラメーター
- thing
-
undefined | null | T
何か
戻り値
thing
isError(unknown)
エラー オブジェクト図形の Typeguard (名前とメッセージを含む)
function isError(e: unknown): eパラメーター
- e
-
unknown
catch 句によってキャッチされる何か。
戻り値
e
isObject(unknown)
入力がジェネリック JS オブジェクトであるタイミングを判断するヘルパー。
function isObject(input: unknown): inputパラメーター
- input
-
unknown
戻り値
input
入力が null、Array、RegExp、または Date 以外のオブジェクト型の場合は true。
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])
入力が指定されたプロパティを持つオブジェクトであるかどうかをチェックするヘルパー TypeGuard。
function isObjectWithProperties<Thing, PropertyName>(thing: Thing, properties: PropertyName[]): thingパラメーター
- thing
-
Thing
何か。
- properties
-
PropertyName[]
オブジェクトに表示するプロパティの名前。
戻り値
thing
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)
入力が指定されたプロパティを持つオブジェクトであるかどうかをチェックするヘルパー TypeGuard。
function objectHasProperty<Thing, PropertyName>(thing: Thing, property: PropertyName): thingパラメーター
- thing
-
Thing
任意のオブジェクト。
- property
-
PropertyName
オブジェクトに表示するプロパティの名前。
戻り値
thing
randomUUID()
生成された汎用一意識別子
function randomUUID(): string戻り値
string
v4 UUID をRFC4122します。
stringToUint8Array(string, EncodingType)
文字列を特定の文字エンコードバイト配列に変換するヘルパー。
function stringToUint8Array(value: string, format: EncodingType): Uint8Arrayパラメーター
- value
-
string
変換する文字列
- format
- EncodingType
値のデコードに使用する形式
戻り値
Uint8Array
a uint8array
uint8ArrayToString(Uint8Array, EncodingType)
特定の文字エンコーディングを持つバイトを文字列に変換するヘルパー
function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): stringパラメーター
- bytes
-
Uint8Array
uint8array バイト
- format
- EncodingType
バイトのエンコードに使用する形式
戻り値
string
エンコードされた文字列の文字列