@azure/core-util package

Interfacce

AbortOptions	Opzioni correlate al controller di interruzione.
CreateAbortablePromiseOptions	Opzioni per la funzione createAbortablePromise.
DelayOptions	Opzioni per il supporto della funzionalità di interruzione per il metodo delay

Alias tipo

AbortablePromiseBuilder	Rappresenta una funzione che restituisce una promessa che può essere interrotta.
EncodingType	Tipo di codifica dei caratteri supportato
HttpMethods	Metodi HTTP supportati da usare per l'esecuzione di richieste.
UnknownObject	Forma generica per un oggetto JS normale.

Funzioni

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Calcola l'intervallo di ritardo per i tentativi usando un ritardo esponenziale con instabilità.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	wrapper promise.race() che interrompe le promesse non appena la prima promessa si risolve.
computeSha256Hash(string, "base64" | "hex")	Genera un hash SHA-256.
computeSha256Hmac(string, string, "base64" | "hex")	Genera una firma HMAC SHA-256.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Crea una promessa interrotta.
delay(number, DelayOptions)	Wrapper per setTimeout che risolve una promessa dopo timeInMs millisecondi.
getErrorMessage(unknown)	Dato ciò che si pensa di essere un oggetto di errore, restituire il messaggio, se possibile. Se il messaggio non è presente, restituisce una versione stringata dell'input.
getRandomIntegerInclusive(number, number)	Restituisce un valore integer casuale tra un limite inferiore e superiore, inclusivo di entrambi i limiti. Si noti che usa Math.random e non è sicuro. Se è necessario usarlo per qualsiasi tipo di scopo di sicurezza, trovare una fonte migliore di casuale.
isDefined<T>(T | null | undefined)	TypeGuard helper che controlla se un elemento è definito o meno.
isError(unknown)	Controllo dei tipi per una forma oggetto di errore (con nome e messaggio)
isObject(unknown)	Helper per determinare quando un input è un oggetto JS generico.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Helper TypeGuard che controlla se l'input è un oggetto con le proprietà specificate.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	TypeGuard helper che controlla se l'input è un oggetto con la proprietà specificata.
randomUUID()	Identificatore univoco universale generato
stringToUint8Array(string, EncodingType)	Helper che trasforma la stringa in una matrice di byte con codifica carattere specifica.
uint8ArrayToString(Uint8Array, EncodingType)	Helper che trasforma i byte con codifica di caratteri specifica in stringa

Variabili

isBrowser	Una costante che indica se l'ambiente in cui il codice esegue è un Web Browser.
isBun	Una costante che indica se l'ambiente in cui il codice esegue è Bun.sh.
isDeno	Una costante che indica se l'ambiente in cui il codice è in esecuzione è Deno.
isNode	Una costante che indica se l'ambiente in cui il codice è in esecuzione è compatibile con Node.js.
isNodeLike	Una costante che indica se l'ambiente in cui il codice è in esecuzione è compatibile con Node.js.
isNodeRuntime	Una costante che indica se l'ambiente in cui il codice esegue è Node.JS.
isReactNative	Una costante che indica se l'ambiente in cui il codice è in esecuzione si trova in React-Native.
isWebWorker	Una costante che indica se l'ambiente in esecuzione del codice è un Web Worker.

Dettagli funzione

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

Calcola l'intervallo di ritardo per i tentativi usando un ritardo esponenziale con instabilità.

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

Parametri

retryAttempt

number

Numero di tentativi corrente.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Configurazione di ripetizione esponenziale dei tentativi.

Valori restituiti

{ retryAfterInMs: number }

Oggetto contenente il ritardo dei tentativi calcolato.

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

wrapper promise.race() che interrompe le promesse non appena la prima promessa si risolve.

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

Parametri

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Valori restituiti

Promise<T[number]>

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

Genera un hash SHA-256.

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

Parametri

content

string

Dati da includere nell'hash.

encoding

"base64" | "hex"

Codifica testuale da utilizzare per l'hash restituito.

Valori restituiti

Promise<string>

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

Genera una firma HMAC SHA-256.

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

Parametri

key

string

Chiave HMAC rappresentata come stringa base64, usata per generare l'hash HMAC crittografico.

stringToSign

string

Dati da firmare.

encoding

"base64" | "hex"

Codifica testuale da usare per il digest HMAC restituito.

Valori restituiti

Promise<string>

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

Crea una promessa interrotta.

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

Parametri

buildPromise

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

Funzione che accetta le funzioni resolve e reject come parametri.

options

CreateAbortablePromiseOptions

Opzioni per la promessa interrotta.

Valori restituiti

Promise<T>

Una promessa che può essere interrotta.

delay(number, DelayOptions)

Wrapper per setTimeout che risolve una promessa dopo timeInMs millisecondi.

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

Parametri

timeInMs

number

Numero di millisecondi da ritardare.

options

DelayOptions

Opzioni per il ritardo : opzioni di interruzione

Valori restituiti

Promise<void>

Promessa risolta dopo timeInMs

getErrorMessage(unknown)

Dato ciò che si pensa di essere un oggetto di errore, restituire il messaggio, se possibile. Se il messaggio non è presente, restituisce una versione stringata dell'input.

function getErrorMessage(e: unknown): string

Parametri

e

unknown

Un'eccezione generata da un blocco try

Valori restituiti

string

Messaggio di errore o stringa dell'input

getRandomIntegerInclusive(number, number)

Restituisce un valore integer casuale tra un limite inferiore e superiore, inclusivo di entrambi i limiti. Si noti che usa Math.random e non è sicuro. Se è necessario usarlo per qualsiasi tipo di scopo di sicurezza, trovare una fonte migliore di casuale.

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

Parametri

min

number

Valore intero più piccolo consentito.

max

number

Valore intero più grande consentito.

Valori restituiti

number

isDefined<T>(T | null | undefined)

TypeGuard helper che controlla se un elemento è definito o meno.

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

Parametri

thing

T | null | undefined

Qualsiasi cosa

Valori restituiti

thing is T

isError(unknown)

Controllo dei tipi per una forma oggetto di errore (con nome e messaggio)

function isError(e: unknown): e is Error

Parametri

e

unknown

Un elemento rilevato da una clausola catch.

Valori restituiti

e is Error

isObject(unknown)

Helper per determinare quando un input è un oggetto JS generico.

function isObject(input: unknown): input is UnknownObject

Parametri

input

unknown

Valori restituiti

input is UnknownObject

true quando l'input è un tipo di oggetto diverso da Null, Array, RegExp o Date.

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

Helper TypeGuard che controlla se l'input è un oggetto con le proprietà specificate.

function isObjectWithProperties<Thing, PropertyName>(thing: Thing, properties: PropertyName[]): thing is Thing & Record<PropertyName, unknown>

Parametri

thing

Thing

Qualsiasi cosa.

properties

PropertyName[]

Nome delle proprietà che devono essere visualizzate nell'oggetto .

Valori restituiti

thing is Thing & Record<PropertyName, unknown>

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

TypeGuard helper che controlla se l'input è un oggetto con la proprietà specificata.

function objectHasProperty<Thing, PropertyName>(thing: Thing, property: PropertyName): thing is Thing & Record<PropertyName, unknown>

Parametri

thing

Thing

Qualsiasi oggetto.

property

PropertyName

Nome della proprietà che deve essere visualizzata nell'oggetto .

Valori restituiti

thing is Thing & Record<PropertyName, unknown>

randomUUID()

Identificatore univoco universale generato

function randomUUID(): string

Valori restituiti

string

RFC4122 UUID v4.

stringToUint8Array(string, EncodingType)

Helper che trasforma la stringa in una matrice di byte con codifica carattere specifica.

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

Parametri

value

string

stringa da convertire

format

EncodingType

il formato usato per decodificare il valore

Valori restituiti

Uint8Array

un uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Helper che trasforma i byte con codifica di caratteri specifica in stringa

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

Parametri

bytes

Uint8Array

byte uint8array

format

EncodingType

il formato usato per codificare il byte

Valori restituiti

string

stringa della stringa codificata

Dettagli delle variabili

isBrowser

Una costante che indica se l'ambiente in cui il codice esegue è un Web Browser.

isBrowser: boolean

Tipo

boolean

isBun

Una costante che indica se l'ambiente in cui il codice esegue è Bun.sh.

isBun: boolean

Tipo

boolean

isDeno

Una costante che indica se l'ambiente in cui il codice è in esecuzione è Deno.

isDeno: boolean

Tipo

boolean

isNode

Avviso

Questa API è ora deprecata.

Use isNodeLike instead.

Una costante che indica se l'ambiente in cui il codice è in esecuzione è compatibile con Node.js.

isNode: boolean

Tipo

boolean

isNodeLike

Una costante che indica se l'ambiente in cui il codice è in esecuzione è compatibile con Node.js.

isNodeLike: boolean

Tipo

boolean

isNodeRuntime

Una costante che indica se l'ambiente in cui il codice esegue è Node.JS.

isNodeRuntime: boolean

Tipo

boolean

isReactNative

Una costante che indica se l'ambiente in cui il codice è in esecuzione si trova in React-Native.

isReactNative: boolean

Tipo

boolean

isWebWorker

Una costante che indica se l'ambiente in esecuzione del codice è un Web Worker.

isWebWorker: boolean

Tipo

boolean