Freigeben über

@azure/core-util package

Schnittstellen

AbortOptions

Optionen im Zusammenhang mit dem Abbruchcontroller.
CreateAbortablePromiseOptions

Optionen für die createAbortablePromise-Funktion.
DelayOptions

Optionen für die Unterstützungsabbruchfunktionalität für die Verzögerungsmethode

Typaliase

AbortablePromiseBuilder

Stellt eine Funktion dar, die eine Zusage zurückgibt, die abgebrochen werden kann.
EncodingType

Der unterstützte Zeichencodierungstyp
HttpMethods

Unterstützte HTTP-Methoden, die beim Senden von Anforderungen verwendet werden sollen.
UnknownObject

Eine generische Form für ein einfaches JS-Objekt.

Functions

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

Berechnet das Verzögerungsintervall für Wiederholungsversuche mit exponentieller Verzögerung mit Jitter.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })

promise.race() wrapper, der die restlichen Zusagen abbricht, sobald sich die erste Zusage absetzt.
computeSha256Hash(string, "base64" | "hex")

Generiert einen SHA-256-Hash.
computeSha256Hmac(string, string, "base64" | "hex")

Generiert eine SHA-256 HMAC-Signatur.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)

Erstellt eine abbruchfähige Zusage.
delay(number, DelayOptions)

Ein Wrapper für setTimeout, der eine Zusage nach timeInMs Millisekunden aufgelöst.
getErrorMessage(unknown)

Wenn sie angenommen wird, dass es sich um ein Fehlerobjekt handelt, geben Sie die Nachricht nach Möglichkeit zurück. Wenn die Nachricht fehlt, wird eine Zeichenfolgenversion der Eingabe zurückgegeben.
getRandomIntegerInclusive(number, number)

Gibt einen zufälligen ganzzahligen Wert zwischen einer unteren und einer oberen Grenze (einschließlich beider Grenzen) zurück. Beachten Sie, dass dies Math.random verwendet und nicht sicher ist. Wenn Sie dies für irgendeine Art von Sicherheitszweck verwenden müssen, finden Sie eine bessere Quelle für zufällige Zwecke.
isDefined<T>(undefined | null | T)

Helper TypeGuard, der überprüft, ob etwas definiert ist oder nicht.
isError(unknown)

Typeguard für ein Fehlerobjekt-Shape (hat Name und Nachricht)
isObject(unknown)

Hilfsprogramm, um zu bestimmen, wann eine Eingabe ein generisches JS-Objekt ist.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])

Hilfsprogramm TypeGuard, der überprüft, ob es sich bei der Eingabe um ein Objekt mit den angegebenen Eigenschaften handelt.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard, der überprüft, ob es sich bei der Eingabe um ein Objekt mit der angegebenen Eigenschaft handelt.
randomUUID()

Generierter universally Unique Identifier
stringToUint8Array(string, EncodingType)

Der Hilfsprogramm, der die Zeichenfolge in ein bestimmtes zeichencodiertes Bytearray transformiert.
uint8ArrayToString(Uint8Array, EncodingType)

Die Hilfsprogramm, die Bytes mit bestimmter Zeichencodierung in eine Zeichenfolge transformiert

Details zur Funktion

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

Berechnet das Verzögerungsintervall für Wiederholungsversuche mit exponentieller Verzögerung mit Jitter.

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

Parameter

retryAttempt

number

Die aktuelle Wiederholungsversuchsnummer.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Die exponentielle Wiederholungskonfiguration.

Gibt zurück

{ retryAfterInMs: number }

Ein Objekt, das die berechnete Wiederholungsverzögerung enthält.

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

promise.race() wrapper, der die restlichen Zusagen abbricht, sobald sich die erste Zusage absetzt.

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

Parameter

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Gibt zurück

Promise<T[number]>

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

Generiert einen SHA-256-Hash.

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

Parameter

content

string

Die Daten, die in den Hash eingeschlossen werden sollen.

encoding

"base64" | "hex"

Die für den zurückgegebenen Hash zu verwendende Textcodierung.

Gibt zurück

Promise<string>

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

Generiert eine SHA-256 HMAC-Signatur.

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

Parameter

key

string

Der HMAC-Schlüssel, der als base64-Zeichenfolge dargestellt wird, wird verwendet, um den kryptografischen HMAC-Hash zu generieren.

stringToSign

string

Die zu signierten Daten.

encoding

"base64" | "hex"

Die textbezogene Codierung, die für den zurückgegebenen HMAC-Digest verwendet werden soll.

Gibt zurück

Promise<string>

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

Erstellt eine abbruchfähige Zusage.

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

Parameter

buildPromise

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

Eine Funktion, die die Funktionen zum Auflösen und Ablehnen als Parameter verwendet.

options
CreateAbortablePromiseOptions

Die Optionen für die abgebrochene Zusage.

Gibt zurück

Promise<T>

Eine Zusage, die abgebrochen werden kann.

delay(number, DelayOptions)

Ein Wrapper für setTimeout, der eine Zusage nach timeInMs Millisekunden aufgelöst.

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

Parameter

timeInMs

number

Die Anzahl der zu verzögernden Millisekunden.

options
DelayOptions

Die Optionen für Verzögerung – derzeit abgebrochene Optionen

Gibt zurück

Promise<void>

Zusage, die nach timeInMs aufgelöst wird

getErrorMessage(unknown)

Wenn sie angenommen wird, dass es sich um ein Fehlerobjekt handelt, geben Sie die Nachricht nach Möglichkeit zurück. Wenn die Nachricht fehlt, wird eine Zeichenfolgenversion der Eingabe zurückgegeben.

function getErrorMessage(e: unknown): string

Parameter

e

unknown

Etwas, das aus einem Try-Block ausgelöst wurde

Gibt zurück

string

Die Fehlermeldung oder eine Zeichenfolge der Eingabe

getRandomIntegerInclusive(number, number)

Gibt einen zufälligen ganzzahligen Wert zwischen einer unteren und einer oberen Grenze (einschließlich beider Grenzen) zurück. Beachten Sie, dass dies Math.random verwendet und nicht sicher ist. Wenn Sie dies für irgendeine Art von Sicherheitszweck verwenden müssen, finden Sie eine bessere Quelle für zufällige Zwecke.

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

Parameter

min

number

Der kleinste ganzzahlige Wert zulässig.

max

number

Der größte zulässige ganzzahlige Wert.

Gibt zurück

number

isDefined<T>(undefined | null | T)

Helper TypeGuard, der überprüft, ob etwas definiert ist oder nicht.

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

Parameter

thing

undefined | null | T

Irgendetwas

Gibt zurück

thing

isError(unknown)

Typeguard für ein Fehlerobjekt-Shape (hat Name und Nachricht)

function isError(e: unknown): e

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e

isObject(unknown)

Hilfsprogramm, um zu bestimmen, wann eine Eingabe ein generisches JS-Objekt ist.

function isObject(input: unknown): input

Parameter

input

unknown

Gibt zurück

input

true, wenn die Eingabe ein Objekttyp ist, der nicht NULL, Array, RegExp oder Date ist.

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

Hilfsprogramm TypeGuard, der überprüft, ob es sich bei der Eingabe um ein Objekt mit den angegebenen Eigenschaften handelt.

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

Parameter

thing

Thing

Irgendetwas.

properties

PropertyName[]

Der Name der Eigenschaften, die im Objekt angezeigt werden sollen.

Gibt zurück

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard, der überprüft, ob es sich bei der Eingabe um ein Objekt mit der angegebenen Eigenschaft handelt.

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

Parameter

thing

Thing

Jedes Objekt.

property

PropertyName

Der Name der Eigenschaft, die im Objekt angezeigt werden soll.

Gibt zurück

thing

randomUUID()

Generierter universally Unique Identifier

function randomUUID(): string

Gibt zurück

string

RFC4122 v4 UUID.

stringToUint8Array(string, EncodingType)

Der Hilfsprogramm, der die Zeichenfolge in ein bestimmtes zeichencodiertes Bytearray transformiert.

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

Parameter

value

string

die zu konvertierende Zeichenfolge

format
EncodingType

das Format, das zum Decodieren des Werts verwendet wird

Gibt zurück

Uint8Array

uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Die Hilfsprogramm, die Bytes mit bestimmter Zeichencodierung in eine Zeichenfolge transformiert

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

Parameter

bytes

Uint8Array

die uint8array Bytes

format
EncodingType

das Format, das zum Codieren des Byte verwendet wird

Gibt zurück

string

eine Zeichenfolge der codierten Zeichenfolge