@azure/core-util package

Interfaces

AbortOptions	Opciones relacionadas con abort controller.
CreateAbortablePromiseOptions	Opciones de la función createAbortablePromise.
DelayOptions	Opciones para admitir la funcionalidad de anulación del método delay

Alias de tipos

AbortablePromiseBuilder	Representa una función que devuelve una promesa que se puede anular.
EncodingType	El tipo de codificación de caracteres admitido
UnknownObject	Forma genérica para un objeto JS sin formato.

Funciones

cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	contenedor promise.race() que anula el resto de promesas tan pronto como se resuelva la primera promesa.
computeSha256Hash(string, "base64" | "hex")	Genera un hash SHA-256.
computeSha256Hmac(string, string, "base64" | "hex")	Genera una firma HMAC SHA-256.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Crea una promesa anulable.
delay(number, DelayOptions)	Contenedor para setTimeout que resuelve una promesa después de milisegundos timeInMs.
getErrorMessage(unknown)	Dado lo que se cree que es un objeto de error, devuelva el mensaje si es posible. Si falta el mensaje, devuelve una versión con cadenas de la entrada.
getRandomIntegerInclusive(number, number)	Devuelve un valor entero aleatorio entre un límite inferior y superior, ambos límites. Tenga en cuenta que esto usa Math.random y no es seguro. Si necesita usarlo para cualquier tipo de propósito de seguridad, busque una mejor fuente de aleatorios.
isDefined<T>(undefined | null | T)	Helper TypeGuard que comprueba si hay algo definido o no.
isError(unknown)	Typeguard para una forma de objeto de error (tiene el nombre y el mensaje)
isObject(unknown)	Asistente para determinar cuándo una entrada es un objeto JS genérico.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Helper TypeGuard que comprueba si la entrada es un objeto con las propiedades especificadas.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Helper TypeGuard que comprueba si la entrada es un objeto con la propiedad especificada.
randomUUID()	Identificador único universal generado
stringToUint8Array(string, EncodingType)	Asistente que transforma la cadena en una matriz de bytes codificada por caracteres específica.
uint8ArrayToString(Uint8Array, EncodingType)	Asistente que transforma bytes con codificación de caracteres específica en cadena.

Detalles de la función

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

contenedor promise.race() que anula el resto de promesas tan pronto como se resuelva la primera promesa.

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

Parámetros

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Devoluciones

Promise<T[number]>

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

Genera un hash SHA-256.

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

Parámetros

content

string

Los datos que se van a incluir en el hash.

encoding

"base64" | "hex"

Codificación textual que se va a usar para el hash devuelto.

Devoluciones

Promise<string>

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

Genera una firma HMAC SHA-256.

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

Parámetros

key

string

La clave HMAC representada como una cadena base64, utilizada para generar el hash HMAC criptográfico.

stringToSign

string

Datos que van a firmar.

encoding

"base64" | "hex"

Codificación textual que se va a usar para el resumen HMAC devuelto.

Devoluciones

Promise<string>

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

Crea una promesa anulable.

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

Parámetros

buildPromise

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

Función que toma las funciones resolve y reject como parámetros.

options

CreateAbortablePromiseOptions

Las opciones de la promesa anulable.

Devoluciones

Promise<T>

Una promesa que se puede anular.

delay(number, DelayOptions)

Contenedor para setTimeout que resuelve una promesa después de milisegundos timeInMs.

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

Parámetros

timeInMs

number

Número de milisegundos que se van a retrasar.

options

DelayOptions

Opciones de retraso: opciones de anulación actualmente

Devoluciones

Promise<void>

Promesa que se resuelve después de timeInMs

getErrorMessage(unknown)

Dado lo que se cree que es un objeto de error, devuelva el mensaje si es posible. Si falta el mensaje, devuelve una versión con cadenas de la entrada.

function getErrorMessage(e: unknown): string

Parámetros

e

unknown

Algo que se produce desde un bloque try

Devoluciones

string

Mensaje de error o una cadena de la entrada

getRandomIntegerInclusive(number, number)

Devuelve un valor entero aleatorio entre un límite inferior y superior, ambos límites. Tenga en cuenta que esto usa Math.random y no es seguro. Si necesita usarlo para cualquier tipo de propósito de seguridad, busque una mejor fuente de aleatorios.

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

Parámetros

min

number

Valor entero más pequeño permitido.

max

number

Valor entero más grande permitido.

Devoluciones

number

isDefined<T>(undefined | null | T)

Helper TypeGuard que comprueba si hay algo definido o no.

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

Parámetros

thing

undefined | null | T

Cualquiera

Devoluciones

thing

isError(unknown)

Typeguard para una forma de objeto de error (tiene el nombre y el mensaje)

function isError(e: unknown): e

Parámetros

e

unknown

Algo capturado por una cláusula catch.

Devoluciones

e

isObject(unknown)

Asistente para determinar cuándo una entrada es un objeto JS genérico.

function isObject(input: unknown): input

Parámetros

input

unknown

Devoluciones

input

true cuando input es un tipo de objeto que no es NULL, Array, RegExp o Date.

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

Helper TypeGuard que comprueba si la entrada es un objeto con las propiedades especificadas.

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

Parámetros

thing

Thing

Cualquier cosa.

properties

PropertyName[]

Nombre de las propiedades que deben aparecer en el objeto .

Devoluciones

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard que comprueba si la entrada es un objeto con la propiedad especificada.

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

Parámetros

thing

Thing

Cualquier objeto.

property

PropertyName

Nombre de la propiedad que debe aparecer en el objeto .

Devoluciones

thing

randomUUID()

Identificador único universal generado

function randomUUID(): string

Devoluciones

string

RFC4122 UUID v4.

stringToUint8Array(string, EncodingType)

Asistente que transforma la cadena en una matriz de bytes codificada por caracteres específica.

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

Parámetros

value

string

la cadena que se va a convertir

format

EncodingType

el formato que usamos para descodificar el valor

Devoluciones

Uint8Array

a uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Asistente que transforma bytes con codificación de caracteres específica en cadena.

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

Parámetros

bytes

Uint8Array

bytes uint8array

format

EncodingType

el formato que usamos para codificar el byte

Devoluciones

string

una cadena de la cadena codificada