Partager via

@azure/core-util package

  • Référence

Interfaces

AbortOptions

Options liées à l’abandon du contrôleur.
CreateAbortablePromiseOptions

Options pour la fonction createAbortablePromise.
DelayOptions

Options de prise en charge de la fonctionnalité 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
UnknownObject

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

Fonctions

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

promise.race() wrapper qui abandonne le reste des promesses dès que la première promesse se règle.
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 avortée.
delay(number, DelayOptions)

Wrapper pour setTimeout qui résout une promesse après timeInMs millisecondes.
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 stringifiée de l’entrée.
getRandomIntegerInclusive(number, number)

Retourne une valeur entière aléatoire entre une limite inférieure et une limite supérieure, y compris les deux limites. Notez que cela utilise Math.random et n’est pas sécurisé. Si vous devez l’utiliser à des fins de sécurité, recherchez une meilleure source de données aléatoires.
isDefined<T>(undefined | null | T)

TypeGuard d’assistance 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)

Aide à déterminer quand une entrée est un objet JS générique.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])

TypeGuard d’assistance 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 universel généré
stringToUint8Array(string, EncodingType)

Helper qui transforme la chaîne en tableau d’octets encodé de caractères spécifiques.
uint8ArrayToString(Uint8Array, EncodingType)

L’assistance qui transforme des octets avec encodage de caractères spécifiques en chaîne

Informations relatives à la fonction

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

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

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

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

stringToSign

string

Données à signer.

encoding

"base64" | "hex"

Encodage textuel à utiliser pour le digest HMAC retourné.

Retours

Promise<string>

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

Crée une promesse avorté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 pour la promesse avortée.

Retours

Promise<T>

Une promesse qui peut être abandonnée.

delay(number, DelayOptions)

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

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

Paramètres

timeInMs

number

Nombre de millisecondes à retarder.

options
DelayOptions

Options de délai : options actuellement 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 stringifiée de l’entrée.

function getErrorMessage(e: unknown): string

Paramètres

e

unknown

Quelque chose lancé à partir d’un bloc d’essai

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 une limite supérieure, y compris les deux limites. Notez que cela utilise Math.random et n’est pas sécurisé. Si vous devez l’utiliser à des fins de sécurité, recherchez une meilleure source de données aléatoires.

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)

TypeGuard d’assistance 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

Tout

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 de rattrapé par une clause catch.

Retours

e

isObject(unknown)

Aide à 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[])

TypeGuard d’assistance 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

Élément quelconque.

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

N’importe quel objet.

property

PropertyName

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

Retours

thing

randomUUID()

Identificateur unique universel généré

function randomUUID(): string

Retours

string

RFC4122 UUID v4.

stringToUint8Array(string, EncodingType)

Helper qui transforme la chaîne en tableau d’octets encodé de caractères spécifiques.

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

Paramètres

value

string

chaîne à convertir

format
EncodingType

format que nous utilisons pour décoder la valeur

Retours

Uint8Array

uint8array

uint8ArrayToString(Uint8Array, EncodingType)

L’assistance qui transforme des octets avec encodage de caractères spécifiques en chaîne

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

Paramètres

bytes

Uint8Array

octets uint8array

format
EncodingType

format que nous utilisons pour encoder l’octet

Retours

string

chaîne de la chaîne encodée