@azure/core-util package
Schnittstellen
| AbortOptions |
Optionen im Zusammenhang mit dem Abbruchcontroller. |
| CreateAbortablePromiseOptions |
Optionen für die funktion createAbortablePromise. |
| DelayOptions |
Optionen für die Unterstützung von Abbruchfunktionen 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 |
| UnknownObject |
Ein generisches Shape für ein einfaches JS-Objekt. |
Functions
| cancelable |
promise.race()-Wrapper, der rest von Versprechen abbricht, sobald sich die erste Zusage ablöst. |
| compute |
Generiert einen SHA-256-Hash. |
| compute |
Generiert eine SHA-256 HMAC-Signatur. |
| create |
Erstellt ein abbruchbares Versprechen. |
| delay(number, Delay |
Ein Wrapper für setTimeout, der eine Zusage nach timeInMs Millisekunden auflöst. |
| get |
Geben Sie die Nachricht nach Möglichkeit zurück, da es sich um ein Fehlerobjekt handelt. Wenn die Nachricht fehlt, gibt eine zeichenfolgenbasierte Version der Eingabe zurück. |
| get |
Gibt einen zufälligen ganzzahligen Wert zwischen einer Unter- und Obergrenze zurück, einschließlich beider Begrenzungen. 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 des Zufalls. |
| is |
Hilfsprogramm TypeGuard, das überprüft, ob etwas definiert ist oder nicht. |
| is |
Typeguard für eine Fehlerobjektform (mit Name und Meldung) |
| is |
Hilfsprogramm, um zu bestimmen, wann eine Eingabe ein generisches JS-Objekt ist. |
| is |
Hilfsprogramm TypeGuard, das überprüft, ob es sich bei der Eingabe um ein Objekt mit den angegebenen Eigenschaften handelt. |
| object |
Hilfsprogramm TypeGuard, das überprüft, ob es sich bei der Eingabe um ein Objekt mit der angegebenen Eigenschaft handelt. |
| randomUUID() | Generierte universally Unique Identifier |
| string |
Das Hilfsprogramm, das Zeichenfolgen in ein bestimmtes zeichencodiertes Bytesarray transformiert. |
| uint8Array |
Das Hilfsprogramm, das Bytes mit einer bestimmten Zeichencodierung in Zeichenfolge transformiert |
Details zur Funktion
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })
promise.race()-Wrapper, der rest von Versprechen abbricht, sobald sich die erste Zusage ablöst.
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 Textcodierung, die für den zurückgegebenen Hash verwendet werden soll.
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 als base64-Zeichenfolge dargestellte HMAC-Schlüssel, der zum Generieren des kryptografischen HMAC-Hashs verwendet wird.
- stringToSign
-
string
Die zu signierenden Daten.
- encoding
-
"base64" | "hex"
Die Textcodierung, 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 ein abbruchbares Versprechen.
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 Auflösungs- und Ablehnungsfunktionen als Parameter übernimmt.
- options
- CreateAbortablePromiseOptions
Die Optionen für das abbruchbare Versprechen.
Gibt zurück
Promise<T>
Ein Versprechen, das abgebrochen werden kann.
delay(number, DelayOptions)
Ein Wrapper für setTimeout, der eine Zusage nach timeInMs Millisekunden auflöst.
function delay(timeInMs: number, options?: DelayOptions): Promise<void>Parameter
- timeInMs
-
number
Die Anzahl der Millisekunden, die verzögert werden sollen.
- options
- DelayOptions
Die Optionen für Verzögerung – derzeit Abbruchoptionen
Gibt zurück
Promise<void>
Zusage, die nach timeInMs aufgelöst wird
getErrorMessage(unknown)
Geben Sie die Nachricht nach Möglichkeit zurück, da es sich um ein Fehlerobjekt handelt. Wenn die Nachricht fehlt, gibt eine zeichenfolgenbasierte Version der Eingabe zurück.
function getErrorMessage(e: unknown): stringParameter
- e
-
unknown
Etwas, das aus einem Testblock ausgelöst wird
Gibt zurück
string
Die Fehlermeldung oder eine Zeichenfolge der Eingabe
getRandomIntegerInclusive(number, number)
Gibt einen zufälligen ganzzahligen Wert zwischen einer Unter- und Obergrenze zurück, einschließlich beider Begrenzungen. 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 des Zufalls.
function getRandomIntegerInclusive(min: number, max: number): numberParameter
- min
-
number
Der kleinste zulässige ganzzahlige Wert.
- max
-
number
Der größte zulässige ganzzahlige Wert.
Gibt zurück
number
isDefined<T>(undefined | null | T)
Hilfsprogramm TypeGuard, das überprüft, ob etwas definiert ist oder nicht.
function isDefined<T>(thing: undefined | null | T): thingParameter
- thing
-
undefined | null | T
Irgendetwas
Gibt zurück
thing
isError(unknown)
Typeguard für eine Fehlerobjektform (mit Name und Meldung)
function isError(e: unknown): eParameter
- e
-
unknown
Etwas, das von einer Catch-Klausel erfasst wird.
Gibt zurück
e
isObject(unknown)
Hilfsprogramm, um zu bestimmen, wann eine Eingabe ein generisches JS-Objekt ist.
function isObject(input: unknown): inputParameter
- 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, das überprüft, ob es sich bei der Eingabe um ein Objekt mit den angegebenen Eigenschaften handelt.
function isObjectWithProperties<Thing, PropertyName>(thing: Thing, properties: PropertyName[]): thingParameter
- thing
-
Thing
Irgendetwas.
- properties
-
PropertyName[]
Der Name der Eigenschaften, die im -Objekt angezeigt werden sollen.
Gibt zurück
thing
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)
Hilfsprogramm TypeGuard, das überprüft, ob es sich bei der Eingabe um ein Objekt mit der angegebenen Eigenschaft handelt.
function objectHasProperty<Thing, PropertyName>(thing: Thing, property: PropertyName): thingParameter
- thing
-
Thing
Beliebiges Objekt.
- property
-
PropertyName
Der Name der Eigenschaft, die im -Objekt angezeigt werden soll.
Gibt zurück
thing
randomUUID()
Generierte universally Unique Identifier
function randomUUID(): stringGibt zurück
string
RFC4122 v4-UUID.
stringToUint8Array(string, EncodingType)
Das Hilfsprogramm, das Zeichenfolgen in ein bestimmtes zeichencodiertes Bytesarray transformiert.
function stringToUint8Array(value: string, format: EncodingType): Uint8ArrayParameter
- value
-
string
die zu konvertierende Zeichenfolge
- format
- EncodingType
das Format, das wir zum Decodieren des Werts verwenden
Gibt zurück
Uint8Array
a uint8array
uint8ArrayToString(Uint8Array, EncodingType)
Das Hilfsprogramm, das Bytes mit einer bestimmten Zeichencodierung in Zeichenfolge transformiert
function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): stringParameter
- bytes
-
Uint8Array
die uint8array-Bytes
- format
- EncodingType
das Format, das wir zum Codieren des Byte verwenden
Gibt zurück
string
eine Zeichenfolge der codierten Zeichenfolge