@azure/core-util package

Gränssnitt

AbortOptions	Alternativ som rör avbruten kontrollant.
CreateAbortablePromiseOptions	Alternativ för funktionen createAbortablePromise.
DelayOptions	Alternativ för stöd för avbrutna funktioner för fördröjningsmetoden

Typalias

AbortablePromiseBuilder	Representerar en funktion som returnerar ett löfte som kan avbrytas.
EncodingType	Teckenkodningstypen som stöds
HttpMethods	HTTP-metoder som stöds när begäranden görs.
UnknownObject	En allmän form för ett vanligt JS-objekt.

Funktioner

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Beräknar fördröjningsintervallet för återförsök med exponentiell fördröjning med jitter.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	promise.race() wrapper som avbryter resten av löftena så snart det första löftet sätter sig.
computeSha256Hash(string, "base64" | "hex")	Genererar en SHA-256-hash.
computeSha256Hmac(string, string, "base64" | "hex")	Genererar en SHA-256 HMAC-signatur.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Skapar ett avbrutet löfte.
delay(number, DelayOptions)	En wrapper för setTimeout som löser ett löfte efter timeInMs millisekunder.
getErrorMessage(unknown)	Med tanke på vad som tros vara ett felobjekt returnerar du meddelandet om möjligt. Om meddelandet saknas returnerar en strängifierad version av indata.
getRandomIntegerInclusive(number, number)	Returnerar ett slumpmässigt heltalsvärde mellan ett lägre och övre gränsvärde, inklusive båda gränserna. Observera att detta använder Math.random och inte är säkert. Om du behöver använda detta för någon form av säkerhetssyfte kan du hitta en bättre källa till slumpmässiga.
isDefined<T>(undefined | null | T)	Helper TypeGuard som kontrollerar om något har definierats eller inte.
isError(unknown)	Typeguard för en felobjektform (har namn och meddelande)
isObject(unknown)	Hjälp för att avgöra när en indata är ett allmänt JS-objekt.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Hjälpverktyget TypeGuard som kontrollerar om indata är ett objekt med de angivna egenskaperna.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Helper TypeGuard som kontrollerar om indata är ett objekt med den angivna egenskapen.
randomUUID()	Genererad universellt unik identifierare
stringToUint8Array(string, EncodingType)	Hjälpen som transformerar strängen till en specifik teckenkodad bytematris.
uint8ArrayToString(Uint8Array, EncodingType)	Hjälpen som omvandlar byte med specifik teckenkodning till sträng

Funktionsinformation

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

Beräknar fördröjningsintervallet för återförsök med exponentiell fördröjning med jitter.

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

Parametrar

retryAttempt

number

Det aktuella återförsöksnumret.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Exponentiell återförsökskonfiguration.

Returer

{ retryAfterInMs: number }

Ett objekt som innehåller den beräknade fördröjningen för återförsök.

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

promise.race() wrapper som avbryter resten av löftena så snart det första löftet sätter sig.

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

Parametrar

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Returer

Promise<T[number]>

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

Genererar en SHA-256-hash.

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

Parametrar

content

string

De data som ska ingå i hashen.

encoding

"base64" | "hex"

Den textkodning som ska användas för den returnerade hashen.

Returer

Promise<string>

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

Genererar en SHA-256 HMAC-signatur.

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

Parametrar

key

string

HMAC-nyckeln representeras som en base64-sträng som används för att generera den kryptografiska HMAC-hashen.

stringToSign

string

De data som ska signeras.

encoding

"base64" | "hex"

Den textkodning som ska användas för den returnerade HMAC-sammandraget.

Returer

Promise<string>

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

Skapar ett avbrutet löfte.

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

Parametrar

buildPromise

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

En funktion som tar funktionerna resolve och reject som parametrar.

options

CreateAbortablePromiseOptions

Alternativen för det avbrutna löftet.

Returer

Promise<T>

Ett löfte som kan avbrytas.

delay(number, DelayOptions)

En wrapper för setTimeout som löser ett löfte efter timeInMs millisekunder.

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

Parametrar

timeInMs

number

Antalet millisekunder som ska fördröjas.

options

DelayOptions

Alternativen för fördröjning – alternativ för närvarande avbrutna

Returer

Promise<void>

Promise that is resolved after timeInMs

getErrorMessage(unknown)

Med tanke på vad som tros vara ett felobjekt returnerar du meddelandet om möjligt. Om meddelandet saknas returnerar en strängifierad version av indata.

function getErrorMessage(e: unknown): string

Parametrar

e

unknown

Något som utlöses från ett försöksblock

Returer

string

Felmeddelandet eller en sträng med indata

getRandomIntegerInclusive(number, number)

Returnerar ett slumpmässigt heltalsvärde mellan ett lägre och övre gränsvärde, inklusive båda gränserna. Observera att detta använder Math.random och inte är säkert. Om du behöver använda detta för någon form av säkerhetssyfte kan du hitta en bättre källa till slumpmässiga.

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

Parametrar

min

number

Det minsta heltalsvärdet som tillåts.

max

number

Det största heltalsvärdet som tillåts.

Returer

number

isDefined<T>(undefined | null | T)

Helper TypeGuard som kontrollerar om något har definierats eller inte.

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

Parametrar

thing

undefined | null | T

Någonting

Returer

thing

isError(unknown)

Typeguard för en felobjektform (har namn och meddelande)

function isError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

isObject(unknown)

Hjälp för att avgöra när en indata är ett allmänt JS-objekt.

function isObject(input: unknown): input

Parametrar

input

unknown

Returer

input

true när indata är en objekttyp som inte är null, Matris, RegExp eller Datum.

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

Hjälpverktyget TypeGuard som kontrollerar om indata är ett objekt med de angivna egenskaperna.

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

Parametrar

thing

Thing

Någonting.

properties

PropertyName[]

Namnet på de egenskaper som ska visas i objektet.

Returer

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard som kontrollerar om indata är ett objekt med den angivna egenskapen.

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

Parametrar

thing

Thing

Alla objekt.

property

PropertyName

Namnet på den egenskap som ska visas i objektet.

Returer

thing

randomUUID()

Genererad universellt unik identifierare

function randomUUID(): string

Returer

string

RFC4122 v4 UUID.

stringToUint8Array(string, EncodingType)

Hjälpen som transformerar strängen till en specifik teckenkodad bytematris.

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

Parametrar

value

string

strängen som ska konverteras

format

EncodingType

formatet vi använder för att avkoda värdet

Returer

Uint8Array

a uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Hjälpen som omvandlar byte med specifik teckenkodning till sträng

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

Parametrar

bytes

Uint8Array

uint8array bytes

format

EncodingType

formatet vi använder för att koda bytet

Returer

string

en sträng med den kodade strängen