@azure/core-util package

Odwołanie

Interfejsy

AbortOptions	Opcje związane z abort kontrolera.
CreateAbortablePromiseOptions	Opcje funkcji createAbortablePromise.
DelayOptions	Opcje obsługi przerwania funkcji dla metody delay

Aliasy typu

AbortablePromiseBuilder	Reprezentuje funkcję zwracającą obietnicę, która może zostać przerwana.
EncodingType	Obsługiwany typ kodowania znaków
HttpMethods	Obsługiwane metody HTTP do użycia podczas wprowadzania żądań.
UnknownObject	Ogólny kształt zwykłego obiektu JS.

Funkcje

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Oblicza interwał opóźnienia dla ponownych prób przy użyciu opóźnienia wykładniczego z roztrzaskiem.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	promise.race() otoka, która przerywa resztę obietnic, gdy tylko pierwsza obietnica się osiedli.
computeSha256Hash(string, "base64" \| "hex")	Generuje skrót SHA-256.
computeSha256Hmac(string, string, "base64" \| "hex")	Generuje podpis SHA-256 HMAC.
createAbortablePromise<T>((resolve: (value: T \| PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Tworzy przerywaną obietnicę.
delay(number, DelayOptions)	Otoka setTimeout, która rozwiązuje obietnicę po milisekundach timeInMs.
getErrorMessage(unknown)	Biorąc pod uwagę, co uważa się za obiekt błędu, zwróć komunikat, jeśli to możliwe. Jeśli brakuje komunikatu, zwraca ciągyfikowaną wersję danych wejściowych.
getRandomIntegerInclusive(number, number)	Zwraca losową wartość całkowitą między dolną i górną granicą, włącznie z obydwoma granicami. Należy pamiętać, że używa metody Math.random i nie jest bezpieczna. Jeśli chcesz użyć tego celu w dowolnym celu zabezpieczeń, znajdź lepsze źródło losowych.
isDefined<T>(undefined \| null \| T)	Pomocnik TypeGuard sprawdza, czy coś jest zdefiniowane, czy nie.
isError(unknown)	Funkcja Typeguard dla kształtu obiektu błędu (ma nazwę i komunikat)
isObject(unknown)	Pomocnik do określenia, kiedy dane wejściowe są ogólnym obiektem JS.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Pomocnik TypeGuard sprawdza, czy dane wejściowe są obiektem o określonych właściwościach.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Pomocnik TypeGuard sprawdza, czy dane wejściowe są obiektem o określonej właściwości.
randomUUID()	Wygenerowany unikatowy identyfikator uniwersalny
stringToUint8Array(string, EncodingType)	Pomocnik, który przekształca ciąg na określony znak zakodowany w tablicy bajtów.
uint8ArrayToString(Uint8Array, EncodingType)	Pomocnik, który przekształca bajty z określonym kodowaniem znaków na ciąg

Szczegóły funkcji

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })

Oblicza interwał opóźnienia dla ponownych prób przy użyciu opóźnienia wykładniczego z roztrzaskiem.

function calculateRetryDelay(retryAttempt: number, config: { maxRetryDelayInMs: number, retryDelayInMs: number }): { retryAfterInMs: number }

Parametry

retryAttempt: number

Bieżący numer próby ponawiania próby.

config: { maxRetryDelayInMs: number, retryDelayInMs: number }

Konfiguracja ponawiania wykładniczego.

Zwraca

{ retryAfterInMs: number }

Obiekt zawierający obliczone opóźnienie ponawiania prób.

cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })

promise.race() otoka, która przerywa resztę obietnic, gdy tylko pierwsza obietnica się osiedli.

function cancelablePromiseRace<T>(abortablePromiseBuilders: AbortablePromiseBuilder<T[number]>[], options?: { abortSignal?: AbortSignalLike }): Promise<T[number]>

Parametry

abortablePromiseBuilders: AbortablePromiseBuilder<T[number]>[]

options: { abortSignal?: AbortSignalLike }

Zwraca

Promise<T[number]>

computeSha256Hash(string, "base64" | "hex")

Generuje skrót SHA-256.

function computeSha256Hash(content: string, encoding: "base64" | "hex"): Promise<string>

Parametry

content: string

Dane, które mają zostać uwzględnione w skrótzie.

encoding: "base64" | "hex"

Kodowanie tekstowe do użycia dla zwróconego skrótu.

Zwraca

Promise<string>

computeSha256Hmac(string, string, "base64" | "hex")

Generuje podpis SHA-256 HMAC.

function computeSha256Hmac(key: string, stringToSign: string, encoding: "base64" | "hex"): Promise<string>

Parametry

key: string

Klucz HMAC reprezentowany jako ciąg base64 używany do generowania kryptograficznego skrótu HMAC.

stringToSign: string

Dane do podpisania.

encoding: "base64" | "hex"

Kodowanie tekstowe do użycia dla zwracanego skrótu HMAC.

Zwraca

Promise<string>

createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)

Tworzy przerywaną obietnicę.

function createAbortablePromise<T>(buildPromise: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, options?: CreateAbortablePromiseOptions): Promise<T>

Parametry

buildPromise: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void

Funkcja, która przyjmuje funkcje rozpoznawania i odrzucania jako parametry.

options: CreateAbortablePromiseOptions

Opcje przerywanej obietnicy.

Zwraca

Promise<T>

Obietnica, którą można przerwać.

delay(number, DelayOptions)

Otoka setTimeout, która rozwiązuje obietnicę po milisekundach timeInMs.

function delay(timeInMs: number, options?: DelayOptions): Promise<void>

Parametry

timeInMs: number

Liczba milisekund, które mają być opóźnione.

options: DelayOptions

Opcje opóźnienia — obecnie przerywane opcje

Zwraca

Promise<void>

Obietnica rozwiązana po funkcji timeInMs

getErrorMessage(unknown)

Biorąc pod uwagę, co uważa się za obiekt błędu, zwróć komunikat, jeśli to możliwe. Jeśli brakuje komunikatu, zwraca ciągyfikowaną wersję danych wejściowych.

function getErrorMessage(e: unknown): string

Parametry

e: unknown

Coś rzuconego z bloku try

Zwraca

string

Komunikat o błędzie lub ciąg danych wejściowych

getRandomIntegerInclusive(number, number)

Zwraca losową wartość całkowitą między dolną i górną granicą, włącznie z obydwoma granicami. Należy pamiętać, że używa metody Math.random i nie jest bezpieczna. Jeśli chcesz użyć tego celu w dowolnym celu zabezpieczeń, znajdź lepsze źródło losowych.

function getRandomIntegerInclusive(min: number, max: number): number

Parametry

min: number

Dozwolona najmniejsza wartość całkowita.

max: number

Dozwolona największa wartość całkowita.

Zwraca

number

isDefined<T>(undefined | null | T)

Pomocnik TypeGuard sprawdza, czy coś jest zdefiniowane, czy nie.

function isDefined<T>(thing: undefined | null | T): thing

Parametry

thing: undefined | null | T

Coś

Zwraca

thing

isError(unknown)

Funkcja Typeguard dla kształtu obiektu błędu (ma nazwę i komunikat)

function isError(e: unknown): e

Parametry

e: unknown

Coś złapanego przez klauzulę catch.

Zwraca

isObject(unknown)

Pomocnik do określenia, kiedy dane wejściowe są ogólnym obiektem JS.

function isObject(input: unknown): input

Parametry

input: unknown

Zwraca

input

wartość true, gdy dane wejściowe są typem obiektu, który nie ma wartości null, Array, RegExp lub Date.

isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])

Pomocnik TypeGuard sprawdza, czy dane wejściowe są obiektem o określonych właściwościach.

function isObjectWithProperties<Thing, PropertyName>(thing: Thing, properties: PropertyName[]): thing

Parametry

thing: Thing

Coś.

properties: PropertyName[]

Nazwa właściwości, które powinny pojawić się w obiekcie.

Zwraca

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Pomocnik TypeGuard sprawdza, czy dane wejściowe są obiektem o określonej właściwości.

function objectHasProperty<Thing, PropertyName>(thing: Thing, property: PropertyName): thing

Parametry

thing: Thing

Dowolny obiekt.

property: PropertyName

Nazwa właściwości, która powinna pojawić się w obiekcie.

Zwraca

thing

randomUUID()

Wygenerowany unikatowy identyfikator uniwersalny

function randomUUID(): string

Zwraca

string

RFC4122 identyfikator UUID w wersji 4.

stringToUint8Array(string, EncodingType)

Pomocnik, który przekształca ciąg na określony znak zakodowany w tablicy bajtów.

function stringToUint8Array(value: string, format: EncodingType): Uint8Array

Parametry

value: string

ciąg, który ma zostać przekonwertowany

format: EncodingType

format używany do dekodowania wartości

Zwraca

Uint8Array

a uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Pomocnik, który przekształca bajty z określonym kodowaniem znaków na ciąg

function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): string

Parametry

bytes: Uint8Array

bajty uint8array

format: EncodingType

format używany do kodowania bajtu

Zwraca

string

ciąg zakodowanego ciągu

Udostępnij za pośrednictwem

@azure/core-util package

Interfejsy

Aliasy typu

Funkcje

Szczegóły funkcji

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })

Parametry

Zwraca

cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })

Parametry

Zwraca

computeSha256Hash(string, "base64" | "hex")

Parametry

Zwraca

computeSha256Hmac(string, string, "base64" | "hex")

Parametry

Zwraca

createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)

Parametry

Zwraca

delay(number, DelayOptions)

Parametry

Zwraca

getErrorMessage(unknown)

Parametry

Zwraca

getRandomIntegerInclusive(number, number)

Parametry

Zwraca

isDefined<T>(undefined | null | T)

Parametry

Zwraca

isError(unknown)

Parametry

Zwraca

isObject(unknown)

Parametry

Zwraca

isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])

Parametry

Zwraca

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Parametry

Zwraca

randomUUID()

Zwraca

stringToUint8Array(string, EncodingType)

Parametry

Zwraca

uint8ArrayToString(Uint8Array, EncodingType)

Parametry

Zwraca

Dodatkowe zasoby