@azure/core-util package

Interfaces

AbortOptions	Opties met betrekking tot het afbreken van de controller.
CreateAbortablePromiseOptions	Opties voor de functie createAbortablePromise.
DelayOptions	Opties voor het afbreken van de functionaliteit voor de vertragingsmethode

Type-aliassen

AbortablePromiseBuilder	Vertegenwoordigt een functie die een belofte retourneert die kan worden afgebroken.
EncodingType	Het ondersteunde tekencoderingstype
HttpMethods	Ondersteunde HTTP-methoden voor gebruik bij het indienen van aanvragen.
UnknownObject	Een algemene vorm voor een gewoon JS-object.

Functies

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Berekent het vertragingsinterval voor nieuwe pogingen met exponentiële vertraging met jitter.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	promise.race() wrapper die de rest van beloften afbreekt zodra de eerste belofte zich vereffent.
computeSha256Hash(string, "base64" | "hex")	Hiermee wordt een SHA-256-hash gegenereerd.
computeSha256Hmac(string, string, "base64" | "hex")	Hiermee wordt een SHA-256 HMAC-handtekening gegenereerd.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Hiermee maakt u een afgebroken belofte.
delay(number, DelayOptions)	Een wrapper voor setTimeout waarmee een belofte na timeInMs milliseconden wordt omgezet.
getErrorMessage(unknown)	Als u krijgt wat een foutobject is, retourneert u het bericht indien mogelijk. Als het bericht ontbreekt, wordt een tekenreeksversie van de invoer geretourneerd.
getRandomIntegerInclusive(number, number)	Retourneert een willekeurig geheel getal tussen een onder- en bovengrens, inclusief beide grenzen. Houd er rekening mee dat dit gebruikmaakt van Math.random en niet veilig is. Als u dit wilt gebruiken voor elk soort beveiligingsdoel, zoekt u een betere bron van willekeurige gegevens.
isDefined<T>(undefined | null | T)	Helper TypeGuard die controleert of er iets is gedefinieerd of niet.
isError(unknown)	Typeguard voor een foutobjectshape (heeft naam en bericht)
isObject(unknown)	Helper om te bepalen wanneer een invoer een algemeen JS-object is.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Helper TypeGuard die controleert of de invoer een object is met de opgegeven eigenschappen.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Helper TypeGuard die controleert of de invoer een object is met de opgegeven eigenschap.
randomUUID()	Universally Unique Identifier gegenereerd
stringToUint8Array(string, EncodingType)	De helper waarmee de tekenreeks wordt getransformeerd naar een specifieke tekencodeerde bytesmatrix.
uint8ArrayToString(Uint8Array, EncodingType)	De helper waarmee bytes met specifieke tekencodering worden getransformeerd in een tekenreeks

Functiedetails

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

Berekent het vertragingsinterval voor nieuwe pogingen met exponentiële vertraging met jitter.

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

Parameters

retryAttempt

number

Het huidige nummer van de nieuwe poging.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

De configuratie voor exponentieel opnieuw proberen.

Retouren

{ retryAfterInMs: number }

Een object met de berekende vertraging voor opnieuw proberen.

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

promise.race() wrapper die de rest van beloften afbreekt zodra de eerste belofte zich vereffent.

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

Parameters

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Retouren

Promise<T[number]>

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

Hiermee wordt een SHA-256-hash gegenereerd.

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

Parameters

content

string

De gegevens die moeten worden opgenomen in de hash.

encoding

"base64" | "hex"

De tekstuele codering die moet worden gebruikt voor de geretourneerde hash.

Retouren

Promise<string>

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

Hiermee wordt een SHA-256 HMAC-handtekening gegenereerd.

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

Parameters

key

string

De HMAC-sleutel die wordt weergegeven als een base64-tekenreeks, die wordt gebruikt om de cryptografische HMAC-hash te genereren.

stringToSign

string

De te ondertekenen gegevens.

encoding

"base64" | "hex"

De tekstuele codering die moet worden gebruikt voor de geretourneerde HMAC-samenvatting.

Retouren

Promise<string>

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

Hiermee maakt u een afgebroken belofte.

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

Parameters

buildPromise

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

Een functie die de omzettings- en weigeringsfuncties als parameters gebruikt.

options

CreateAbortablePromiseOptions

De opties voor de afgebroken belofte.

Retouren

Promise<T>

Een belofte die kan worden afgebroken.

delay(number, DelayOptions)

Een wrapper voor setTimeout waarmee een belofte na timeInMs milliseconden wordt omgezet.

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

Parameters

timeInMs

number

Het aantal milliseconden dat moet worden vertraagd.

options

DelayOptions

De opties voor vertraging - momenteel opties afbreken

Retouren

Promise<void>

Belofte die is opgelost na timeInMs

getErrorMessage(unknown)

Als u krijgt wat een foutobject is, retourneert u het bericht indien mogelijk. Als het bericht ontbreekt, wordt een tekenreeksversie van de invoer geretourneerd.

function getErrorMessage(e: unknown): string

Parameters

e

unknown

Iets dat is gegenereerd vanuit een try-blok

Retouren

string

Het foutbericht of een tekenreeks van de invoer

getRandomIntegerInclusive(number, number)

Retourneert een willekeurig geheel getal tussen een onder- en bovengrens, inclusief beide grenzen. Houd er rekening mee dat dit gebruikmaakt van Math.random en niet veilig is. Als u dit wilt gebruiken voor elk soort beveiligingsdoel, zoekt u een betere bron van willekeurige gegevens.

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

Parameters

min

number

De kleinste gehele waarde is toegestaan.

max

number

De grootste waarde voor gehele getallen is toegestaan.

Retouren

number

isDefined<T>(undefined | null | T)

Helper TypeGuard die controleert of er iets is gedefinieerd of niet.

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

Parameters

thing

undefined | null | T

Iets

Retouren

thing

isError(unknown)

Typeguard voor een foutobjectshape (heeft naam en bericht)

function isError(e: unknown): e

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e

isObject(unknown)

Helper om te bepalen wanneer een invoer een algemeen JS-object is.

function isObject(input: unknown): input

Parameters

input

unknown

Retouren

input

waar wanneer invoer een objecttype is dat niet null, Matrix, RegExp of Datum is.

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

Helper TypeGuard die controleert of de invoer een object is met de opgegeven eigenschappen.

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

Parameters

thing

Thing

Iets.

properties

PropertyName[]

De naam van de eigenschappen die in het object moeten worden weergegeven.

Retouren

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard die controleert of de invoer een object is met de opgegeven eigenschap.

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

Parameters

thing

Thing

Elk object.

property

PropertyName

De naam van de eigenschap die in het object moet worden weergegeven.

Retouren

thing

randomUUID()

Universally Unique Identifier gegenereerd

function randomUUID(): string

Retouren

string

RFC4122 v4 UUID.

stringToUint8Array(string, EncodingType)

De helper waarmee de tekenreeks wordt getransformeerd naar een specifieke tekencodeerde bytesmatrix.

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

Parameters

value

string

de tekenreeks die moet worden geconverteerd

format

EncodingType

de indeling die we gebruiken om de waarde te decoderen

Retouren

Uint8Array

een uint8array

uint8ArrayToString(Uint8Array, EncodingType)

De helper waarmee bytes met specifieke tekencodering worden getransformeerd in een tekenreeks

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

Parameters

bytes

Uint8Array

de uint8array-bytes

format

EncodingType

de indeling die we gebruiken om de byte te coderen

Retouren

string

een tekenreeks van de gecodeerde tekenreeks