@azure/core-util package

Rozhraní

AbortOptions	Možnosti související s kontrolerem přerušení
CreateAbortablePromiseOptions	Možnosti pro funkci createAbortablePromise
DelayOptions	Možnosti podpory funkce přerušení metody zpoždění

Aliasy typu

AbortablePromiseBuilder	Představuje funkci, která vrací příslib, který lze přerušit.
EncodingType	Podporovaný typ kódování znaků
HttpMethods	Podporované metody HTTP, které se používají při provádění požadavků.
UnknownObject	Obecný obrazec pro prostý objekt JS.

Funkce

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Vypočítá interval zpoždění pro pokusy o opakování pomocí exponenciálního zpoždění se zpožděním.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	promise.race() obálka, která přeruší zbytek slibů, jakmile se první příslib uspořádá.
computeSha256Hash(string, "base64" | "hex")	Vygeneruje hodnotu hash SHA-256.
computeSha256Hmac(string, string, "base64" | "hex")	Vygeneruje podpis SHA-256 HMAC.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Vytvoří přerušený slib.
delay(number, DelayOptions)	Obálka pro setTimeout, která vyřeší příslib po timeInMs milisekundy.
getErrorMessage(unknown)	Vzhledem k tomu, co je považováno za objekt chyby, vraťte zprávu, pokud je to možné. Pokud zpráva chybí, vrátí řetězecifikovanou verzi vstupu.
getRandomIntegerInclusive(number, number)	Vrátí náhodnou celočíselnou hodnotu mezi dolní a horní mez včetně obou hranic. Všimněte si, že tato funkce používá Math.random a není zabezpečená. Pokud to potřebujete použít pro jakýkoli druh zabezpečení, vyhledejte lepší zdroj náhodných dat.
isDefined<T>(undefined | null | T)	Helper TypeGuard, který kontroluje, jestli je něco definováno nebo ne.
isError(unknown)	Typeguard pro obrazec objektu chyby (má název a zprávu)
isObject(unknown)	Pomocná rutina k určení, kdy vstup je obecný objekt JS.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Pomocník TypeGuard, který kontroluje, zda vstup je objekt se zadanými vlastnostmi.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Helper TypeGuard, který kontroluje, zda vstup je objekt se zadanou vlastností.
randomUUID()	Vygenerovaný univerzální jedinečný identifikátor
stringToUint8Array(string, EncodingType)	Pomocník, který transformuje řetězec na konkrétní znak kódované bajty pole.
uint8ArrayToString(Uint8Array, EncodingType)	Pomocná rutina, která transformuje bajty s konkrétním kódováním znaků na řetězec

Proměnné

isBrowser	Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, webový prohlížeč.
isBun	Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Bun.sh.
isDeno	Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, je Deno.
isNode	Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Node.js kompatibilní.
isNodeLike	Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Node.js kompatibilní.
isNodeRuntime	Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Node.JS.
isReactNative	Konstanta, která ukazuje, zda prostředí kódu běží, je v React-Native.
isWebWorker	Konstanta, která ukazuje, zda prostředí, ve kterém kód běží, je Web Worker.

Podrobnosti funkce

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

Vypočítá interval zpoždění pro pokusy o opakování pomocí exponenciálního zpoždění se zpožděním.

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

Parametry

retryAttempt

number

Číslo aktuálního pokusu o opakování.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Exponenciální konfigurace opakování.

Návraty

{ retryAfterInMs: number }

Objekt obsahující vypočítané zpoždění opakování.

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

promise.race() obálka, která přeruší zbytek slibů, jakmile se první příslib uspořádá.

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

Parametry

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Návraty

Promise<T[number]>

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

Vygeneruje hodnotu hash SHA-256.

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

Parametry

content

string

Data, která se mají zahrnout do hodnoty hash.

encoding

"base64" | "hex"

Textové kódování, které se má použít pro vrácenou hodnotu hash.

Návraty

Promise<string>

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

Vygeneruje podpis SHA-256 HMAC.

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

Parametry

key

string

Klíč HMAC reprezentovaný jako řetězec base64, který se používá k vygenerování kryptografické hodnoty hash HMAC.

stringToSign

string

Data, která se mají podepsat.

encoding

"base64" | "hex"

Textové kódování, které se má použít pro vrácenou funkci hash HMAC.

Návraty

Promise<string>

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

Vytvoří přerušený slib.

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

Parametry

buildPromise

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

Funkce, která přebírá funkce resolve a reject jako parametry.

options

CreateAbortablePromiseOptions

Možnosti přerušení slibu.

Návraty

Promise<T>

Slib, který může být přerušen.

delay(number, DelayOptions)

Obálka pro setTimeout, která vyřeší příslib po timeInMs milisekundy.

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

Parametry

timeInMs

number

Počet milisekund, které mají být zpožděny.

options

DelayOptions

Možnosti zpoždění – aktuálně přerušené možnosti

Návraty

Promise<void>

Příslib, který se vyřeší po vypršení časových intervalů

getErrorMessage(unknown)

Vzhledem k tomu, co je považováno za objekt chyby, vraťte zprávu, pokud je to možné. Pokud zpráva chybí, vrátí řetězecifikovanou verzi vstupu.

function getErrorMessage(e: unknown): string

Parametry

e

unknown

Něco vyvolané z bloku try

Návraty

string

Chybová zpráva nebo řetězec vstupu

getRandomIntegerInclusive(number, number)

Vrátí náhodnou celočíselnou hodnotu mezi dolní a horní mez včetně obou hranic. Všimněte si, že tato funkce používá Math.random a není zabezpečená. Pokud to potřebujete použít pro jakýkoli druh zabezpečení, vyhledejte lepší zdroj náhodných dat.

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

Parametry

min

number

Nejmenší povolená celočíselná hodnota.

max

number

Největší povolená celočíselná hodnota.

Návraty

number

isDefined<T>(undefined | null | T)

Helper TypeGuard, který kontroluje, jestli je něco definováno nebo ne.

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

Parametry

thing

undefined | null | T

Cokoliv

Návraty

thing

isError(unknown)

Typeguard pro obrazec objektu chyby (má název a zprávu)

function isError(e: unknown): e

Parametry

e

unknown

Něco zachyceného klauzulí catch.

Návraty

e

isObject(unknown)

Pomocná rutina k určení, kdy vstup je obecný objekt JS.

function isObject(input: unknown): input

Parametry

input

unknown

Návraty

input

true, pokud vstup je typ objektu, který není null, Array, RegExp nebo Date.

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

Pomocník TypeGuard, který kontroluje, zda vstup je objekt se zadanými vlastnostmi.

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

Parametry

thing

Thing

Cokoliv.

properties

PropertyName[]

Název vlastností, které by se měly zobrazit v objektu.

Návraty

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard, který kontroluje, zda vstup je objekt se zadanou vlastností.

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

Parametry

thing

Thing

Libovolný objekt.

property

PropertyName

Název vlastnosti, která by se měla v objektu objevit.

Návraty

thing

randomUUID()

Vygenerovaný univerzální jedinečný identifikátor

function randomUUID(): string

Návraty

string

RFC4122 UUID v4.

stringToUint8Array(string, EncodingType)

Pomocník, který transformuje řetězec na konkrétní znak kódované bajty pole.

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

Parametry

value

string

řetězec, který se má převést

format

EncodingType

formát, který používáme k dekódování hodnoty

Návraty

Uint8Array

a uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Pomocná rutina, která transformuje bajty s konkrétním kódováním znaků na řetězec

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

Parametry

bytes

Uint8Array

bajty uint8array

format

EncodingType

formát, který používáme k kódování bajtu

Návraty

string

řetězec zakódovaného řetězce

Variable Details

isBrowser

Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, webový prohlížeč.

isBrowser: boolean

Typ

boolean

isBun

Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Bun.sh.

isBun: boolean

Typ

boolean

isDeno

Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, je Deno.

isDeno: boolean

Typ

boolean

isNode

Upozornění

Toto rozhraní API je teď zastaralé.

Use isNodeLike instead.

Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Node.js kompatibilní.

isNode: boolean

Typ

boolean

isNodeLike

Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Node.js kompatibilní.

isNodeLike: boolean

Typ

boolean

isNodeRuntime

Konstanta, která ukazuje, zda je prostředí, ve kterém kód běží, Node.JS.

isNodeRuntime: boolean

Typ

boolean

isReactNative

Konstanta, která ukazuje, zda prostředí kódu běží, je v React-Native.

isReactNative: boolean

Typ

boolean

isWebWorker

Konstanta, která ukazuje, zda prostředí, ve kterém kód běží, je Web Worker.

isWebWorker: boolean

Typ

boolean