@azure/core-util package

Felületek

AbortOptions	A megszakításvezérlővel kapcsolatos beállítások.
CreateAbortablePromiseOptions	A createAbortablePromise függvény beállításai.
DelayOptions	A késleltetési módszer megszakítási funkciójának támogatásának lehetőségei

Típus-aliasok

AbortablePromiseBuilder	Olyan függvényt jelöl, amely megszakítható ígéretet ad vissza.
EncodingType	A támogatott karakterkódolás típusa
HttpMethods	Támogatott HTTP-metódusok a kérések során.
UnknownObject	Egy egyszerű JS-objektum általános alakzata.

Functions

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Kiszámítja az újrapróbálkozási kísérletek késleltetési időközét exponenciális késleltetés és jitter használatával.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	promise.race() burkoló, amely megszakítja a többi ígéretet, amint az első ígéret beérik.
computeSha256Hash(string, "base64" | "hex")	SHA-256 kivonatot hoz létre.
computeSha256Hmac(string, string, "base64" | "hex")	SHA-256 HMAC-aláírást hoz létre.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Megszakítható ígéretet hoz létre.
delay(number, DelayOptions)	A setTimeout burkolója, amely a timeInMs ezredmásodperc után felold egy ígéretet.
getErrorMessage(unknown)	Ha lehetséges, adja vissza az üzenetet, ha lehetséges, a hibaobjektumot tekintve. Ha az üzenet hiányzik, a bemenet sztringezett verzióját adja vissza.
getRandomIntegerInclusive(number, number)	Véletlenszerű egész számot ad vissza egy alsó és egy felső határ között, a két határt is beleértve. Vegye figyelembe, hogy ez a Math.random függvényt használja, és nem biztonságos. Ha ezt bármilyen biztonsági célra használnia kell, keressen jobb véletlenszerű forrást.
isDefined<T>(undefined | null | T)	A TypeGuard súgója, amely ellenőrzi, hogy van-e definiálva valami.
isError(unknown)	Hibaobjektum-alakzat típusőrzője (névvel és üzenetsel rendelkezik)
isObject(unknown)	Segéd annak meghatározásához, hogy egy bemenet általános JS-objektum-e.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	A TypeGuard segéd, amely ellenőrzi, hogy a bemenet egy adott tulajdonságokkal rendelkező objektum-e.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	A TypeGuard segéd, amely ellenőrzi, hogy a bemenet egy objektum-e a megadott tulajdonsággal.
randomUUID()	Generált univerzálisan egyedi azonosító
stringToUint8Array(string, EncodingType)	Az a segéd, amely a sztringet adott karakterkódolt bájttömbté alakítja át.
uint8ArrayToString(Uint8Array, EncodingType)	Az a segéd, amely adott karakterkódolással rendelkező bájtokat sztringgé alakít át

Változók

isBrowser	Egy állandó, amely jelzi, hogy a kód által futó környezet webböngésző-e.
isBun	Egy állandó, amely jelzi, hogy a kód által futó környezet Bun.sh.
isDeno	Egy állandó, amely jelzi, hogy a kód által futó környezet Deno-t.
isNode	Egy állandó, amely jelzi, hogy a kód által futó környezet Node.js kompatibilis-e.
isNodeLike	Egy állandó, amely jelzi, hogy a kód által futó környezet Node.js kompatibilis-e.
isNodeRuntime	Egy állandó, amely jelzi, hogy a kód által futó környezet Node.JS.
isReactNative	Egy állandó, amely jelzi, hogy a kód által futó környezet React-Native formátumban van-e.
isWebWorker	Egy állandó, amely jelzi, hogy a kód által futó környezet Webworker-e.

Funkciók részletei

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

Kiszámítja az újrapróbálkozási kísérletek késleltetési időközét exponenciális késleltetés és jitter használatával.

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

Paraméterek

retryAttempt

number

Az újrapróbálkozási kísérlet aktuális száma.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Az exponenciális újrapróbálkozási konfiguráció.

Visszatér

{ retryAfterInMs: number }

A számított újrapróbálkozási késleltetést tartalmazó objektum.

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

promise.race() burkoló, amely megszakítja a többi ígéretet, amint az első ígéret beérik.

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

Paraméterek

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Visszatér

Promise<T[number]>

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

SHA-256 kivonatot hoz létre.

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

Paraméterek

content

string

A kivonatban szerepeltetni kívánt adatok.

encoding

"base64" | "hex"

A visszaadott kivonathoz használandó szöveges kódolás.

Visszatér

Promise<string>

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

SHA-256 HMAC-aláírást hoz létre.

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

Paraméterek

key

string

A HMAC-kulcs base64 sztringként jelenik meg, amely a titkosítási HMAC kivonat létrehozásához használatos.

stringToSign

string

Az aláírandó adatok.

encoding

"base64" | "hex"

A visszaadott HMAC-kivonathoz használandó szöveges kódolás.

Visszatér

Promise<string>

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

Megszakítható ígéretet hoz létre.

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

Paraméterek

buildPromise

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

Egy függvény, amely paraméterekként veszi fel a feloldó és elutasító függvényeket.

options

CreateAbortablePromiseOptions

A megszakítható ígéret lehetőségei.

Visszatér

Promise<T>

Egy ígéret, amely megszakítható.

delay(number, DelayOptions)

A setTimeout burkolója, amely a timeInMs ezredmásodperc után felold egy ígéretet.

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

Paraméterek

timeInMs

number

A késleltetni kívánt ezredmásodpercek száma.

options

DelayOptions

A késleltetési lehetőségek – jelenleg megszakított beállítások

Visszatér

Promise<void>

A timeInMs után feloldott ígéret

getErrorMessage(unknown)

Ha lehetséges, adja vissza az üzenetet, ha lehetséges, a hibaobjektumot tekintve. Ha az üzenet hiányzik, a bemenet sztringezett verzióját adja vissza.

function getErrorMessage(e: unknown): string

Paraméterek

e

unknown

Valami, amit egy próbablokkból dobtak ki

Visszatér

string

A hibaüzenet vagy a bemenet sztringje

getRandomIntegerInclusive(number, number)

Véletlenszerű egész számot ad vissza egy alsó és egy felső határ között, a két határt is beleértve. Vegye figyelembe, hogy ez a Math.random függvényt használja, és nem biztonságos. Ha ezt bármilyen biztonsági célra használnia kell, keressen jobb véletlenszerű forrást.

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

Paraméterek

min

number

Az engedélyezett legkisebb egész számérték.

max

number

Az engedélyezett legnagyobb egész szám.

Visszatér

number

isDefined<T>(undefined | null | T)

A TypeGuard súgója, amely ellenőrzi, hogy van-e definiálva valami.

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

Paraméterek

thing

undefined | null | T

Bármi

Visszatér

thing

isError(unknown)

Hibaobjektum-alakzat típusőrzője (névvel és üzenetsel rendelkezik)

function isError(e: unknown): e

Paraméterek

e

unknown

Valami, amit egy fogási záradék fog.

Visszatér

e

isObject(unknown)

Segéd annak meghatározásához, hogy egy bemenet általános JS-objektum-e.

function isObject(input: unknown): input

Paraméterek

input

unknown

Visszatér

input

igaz, ha a bemenet nem null értékű objektumtípus, Tömb, RegExp vagy Dátum.

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

A TypeGuard segéd, amely ellenőrzi, hogy a bemenet egy adott tulajdonságokkal rendelkező objektum-e.

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

Paraméterek

thing

Thing

Bármi.

properties

PropertyName[]

Az objektumban megjelenő tulajdonságok neve.

Visszatér

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

A TypeGuard segéd, amely ellenőrzi, hogy a bemenet egy objektum-e a megadott tulajdonsággal.

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

Paraméterek

thing

Thing

Bármilyen objektum.

property

PropertyName

Az objektumban megjelenő tulajdonság neve.

Visszatér

thing

randomUUID()

Generált univerzálisan egyedi azonosító

function randomUUID(): string

Visszatér

string

RFC4122 v4 UUID azonosítót.

stringToUint8Array(string, EncodingType)

Az a segéd, amely a sztringet adott karakterkódolt bájttömbté alakítja át.

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

Paraméterek

value

string

a konvertálni kívánt sztring

format

EncodingType

az érték dekódolásához használt formátum

Visszatér

Uint8Array

egy uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Az a segéd, amely adott karakterkódolással rendelkező bájtokat sztringgé alakít át

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

Paraméterek

bytes

Uint8Array

az uint8array bájt

format

EncodingType

a bájt kódolásához használt formátum

Visszatér

string

a kódolt sztring egy sztringje

Variable Details

isBrowser

Egy állandó, amely jelzi, hogy a kód által futó környezet webböngésző-e.

isBrowser: boolean

Típus

boolean

isBun

Egy állandó, amely jelzi, hogy a kód által futó környezet Bun.sh.

isBun: boolean

Típus

boolean

isDeno

Egy állandó, amely jelzi, hogy a kód által futó környezet Deno-t.

isDeno: boolean

Típus

boolean

isNode

Figyelmeztetés

Ez az API most már elavult volt.

Use isNodeLike instead.

Egy állandó, amely jelzi, hogy a kód által futó környezet Node.js kompatibilis-e.

isNode: boolean

Típus

boolean

isNodeLike

Egy állandó, amely jelzi, hogy a kód által futó környezet Node.js kompatibilis-e.

isNodeLike: boolean

Típus

boolean

isNodeRuntime

Egy állandó, amely jelzi, hogy a kód által futó környezet Node.JS.

isNodeRuntime: boolean

Típus

boolean

isReactNative

Egy állandó, amely jelzi, hogy a kód által futó környezet React-Native formátumban van-e.

isReactNative: boolean

Típus

boolean

isWebWorker

Egy állandó, amely jelzi, hogy a kód által futó környezet Webworker-e.

isWebWorker: boolean

Típus

boolean