Partager via


@azure/core-util package

Interfaces

AbortOptions

Options relatives au contrôleur d’abandon.

CreateAbortablePromiseOptions

Options de la fonction createAbortablePromise.

DelayOptions

Options pour la prise en charge des fonctionnalités d’abandon pour la méthode delay

Alias de type

AbortablePromiseBuilder

Représente une fonction qui retourne une promesse qui peut être abandonnée.

EncodingType

Type d’encodage de caractères pris en charge

HttpMethods

Méthodes HTTP prises en charge à utiliser lors de l’établissement de requêtes.

UnknownObject

Forme générique pour un objet JS brut.

Functions

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

Calcule l’intervalle de délai pour les tentatives de nouvelle tentative à l’aide d’un délai exponentiel avec une gigue.

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

wrapper promise.race() qui abandonne le reste des promesses dès que la première promesse s’installe.

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

Génère un hachage SHA-256.

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

Génère une signature HMAC SHA-256.

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

Crée une promesse abandonnée.

delay(number, DelayOptions)

Wrapper pour setTimeout qui résout une promesse après les millisecondes timeInMs.

getErrorMessage(unknown)

Étant donné ce qui est considéré comme un objet d’erreur, retournez le message si possible. Si le message est manquant, retourne une version chaîne de l’entrée.

getRandomIntegerInclusive(number, number)

Retourne une valeur entière aléatoire entre une limite inférieure et supérieure, inclusive des deux limites. Notez que cela utilise Math.random et n’est pas sécurisé. Si vous devez l’utiliser pour n’importe quel type de sécurité, recherchez une meilleure source de hasard.

isDefined<T>(undefined | null | T)

Helper TypeGuard qui vérifie si quelque chose est défini ou non.

isError(unknown)

Typeguard pour une forme d’objet d’erreur (a le nom et le message)

isObject(unknown)

Assistance pour déterminer quand une entrée est un objet JS générique.

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

Helper TypeGuard qui vérifie si l’entrée est un objet avec les propriétés spécifiées.

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard qui vérifie si l’entrée est un objet avec la propriété spécifiée.

randomUUID()

Identificateur unique généré universellement

stringToUint8Array(string, EncodingType)

L’assistance qui transforme la chaîne en tableau d’octets encodés en caractères spécifiques.

uint8ArrayToString(Uint8Array, EncodingType)

Assistance qui transforme les octets avec un encodage de caractères spécifique en chaîne

Informations relatives à la fonction

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

Calcule l’intervalle de délai pour les tentatives de nouvelle tentative à l’aide d’un délai exponentiel avec une gigue.

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

Paramètres

retryAttempt

number

Numéro de nouvelle tentative actuel.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Configuration de nouvelle tentative exponentielle.

Retours

{ retryAfterInMs: number }

Objet contenant le délai de nouvelle tentative calculé.

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

wrapper promise.race() qui abandonne le reste des promesses dès que la première promesse s’installe.

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

Paramètres

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Retours

Promise<T[number]>

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

Génère un hachage SHA-256.

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

Paramètres

content

string

Données à inclure dans le hachage.

encoding

"base64" | "hex"

Encodage textuel à utiliser pour le hachage retourné.

Retours

Promise<string>

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

Génère une signature HMAC SHA-256.

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

Paramètres

key

string

La clé HMAC représentée sous la forme d’une chaîne base64, utilisée pour générer le hachage HMAC de chiffrement.

stringToSign

string

Données à signer.

encoding

"base64" | "hex"

Encodage textuel à utiliser pour la synthèse HMAC retournée.

Retours

Promise<string>

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

Crée une promesse abandonnée.

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

Paramètres

buildPromise

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

Fonction qui prend les fonctions de résolution et de rejet en tant que paramètres.

options
CreateAbortablePromiseOptions

Options de la promesse abandonnée.

Retours

Promise<T>

Une promesse qui peut être abandonnée.

delay(number, DelayOptions)

Wrapper pour setTimeout qui résout une promesse après les millisecondes timeInMs.

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

Paramètres

timeInMs

number

Nombre de millisecondes à retarder.

options
DelayOptions

Options de délai - options d’abandon

Retours

Promise<void>

Promesse résolue après timeInMs

getErrorMessage(unknown)

Étant donné ce qui est considéré comme un objet d’erreur, retournez le message si possible. Si le message est manquant, retourne une version chaîne de l’entrée.

function getErrorMessage(e: unknown): string

Paramètres

e

unknown

Quelque chose levée à partir d’un bloc try

Retours

string

Message d’erreur ou chaîne de l’entrée

getRandomIntegerInclusive(number, number)

Retourne une valeur entière aléatoire entre une limite inférieure et supérieure, inclusive des deux limites. Notez que cela utilise Math.random et n’est pas sécurisé. Si vous devez l’utiliser pour n’importe quel type de sécurité, recherchez une meilleure source de hasard.

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

Paramètres

min

number

Valeur entière la plus petite autorisée.

max

number

Valeur entière la plus grande autorisée.

Retours

number

isDefined<T>(undefined | null | T)

Helper TypeGuard qui vérifie si quelque chose est défini ou non.

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

Paramètres

thing

undefined | null | T

Rien

Retours

thing

isError(unknown)

Typeguard pour une forme d’objet d’erreur (a le nom et le message)

function isError(e: unknown): e

Paramètres

e

unknown

Quelque chose d’intercepté par une clause catch.

Retours

e

isObject(unknown)

Assistance pour déterminer quand une entrée est un objet JS générique.

function isObject(input: unknown): input

Paramètres

input

unknown

Retours

input

true lorsque l’entrée est un type d’objet qui n’est pas null, Array, RegExp ou Date.

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

Helper TypeGuard qui vérifie si l’entrée est un objet avec les propriétés spécifiées.

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

Paramètres

thing

Thing

Rien.

properties

PropertyName[]

Nom des propriétés qui doivent apparaître dans l’objet.

Retours

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard qui vérifie si l’entrée est un objet avec la propriété spécifiée.

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

Paramètres

thing

Thing

Tout objet.

property

PropertyName

Nom de la propriété qui doit apparaître dans l’objet.

Retours

thing

randomUUID()

Identificateur unique généré universellement

function randomUUID(): string

Retours

string

RFC4122 v4 UUID.

stringToUint8Array(string, EncodingType)

L’assistance qui transforme la chaîne en tableau d’octets encodés en caractères spécifiques.

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

Paramètres

value

string

chaîne à convertir

format
EncodingType

le format que nous utilisons pour décoder la valeur

Retours

Uint8Array

un uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Assistance qui transforme les octets avec un encodage de caractères spécifique en chaîne

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

Paramètres

bytes

Uint8Array

octets uint8array

format
EncodingType

le format que nous utilisons pour encoder l’octet

Retours

string

chaîne de la chaîne encodée