@azure/core-util package
Interfaces
AbortOptions |
Opções relacionadas ao controlador de anulação. |
CreateAbortablePromiseOptions |
Opções para a função createAbortablePromise. |
DelayOptions |
Opções para funcionalidade de anulação de suporte para o método de atraso |
Aliases de tipo
AbortablePromiseBuilder |
Representa uma função que retorna uma promessa que pode ser anulada. |
EncodingType |
O tipo de codificação de caractere com suporte |
HttpMethods |
Métodos HTTP com suporte para usar ao fazer solicitações. |
UnknownObject |
Uma forma genérica para um objeto JS simples. |
Funções
calculate |
Calcula o intervalo de atraso para tentativas de repetição usando atraso exponencial com tremulação. |
cancelable |
wrapper promise.race() que anula o resto das promessas assim que a primeira promessa se estabelece. |
compute |
Gera um hash SHA-256. |
compute |
Gera uma assinatura HMAC SHA-256. |
create |
Cria uma promessa anulável. |
delay(number, Delay |
Um wrapper para setTimeout que resolve uma promessa após milissegundos timeInMs. |
get |
Considerando o que se pensa ser um objeto de erro, retorne a mensagem, se possível. Se a mensagem estiver ausente, retornará uma versão em cadeia de caracteres da entrada. |
get |
Retorna um valor inteiro aleatório entre um limite inferior e superior, inclusive de ambos os limites. Observe que isso usa Math.random e não é seguro. Se você precisar usá-lo para qualquer tipo de finalidade de segurança, encontre uma melhor fonte aleatória. |
is |
O Helper TypeGuard verifica se algo está definido ou não. |
is |
Typeguard para uma forma de objeto de erro (tem nome e mensagem) |
is |
Auxiliar para determinar quando uma entrada é um objeto JS genérico. |
is |
O Helper TypeGuard verifica se a entrada é um objeto com as propriedades especificadas. |
object |
O Helper TypeGuard verifica se a entrada é um objeto com a propriedade especificada. |
randomUUID() | Identificador Universalmente Exclusivo Gerado |
string |
O auxiliar que transforma a cadeia de caracteres em uma matriz de bytes codificada por caractere específico. |
uint8Array |
O auxiliar que transforma bytes com codificação de caractere específica em cadeia de caracteres |
Detalhes da função
calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })
Calcula o intervalo de atraso para tentativas de repetição usando atraso exponencial com tremulação.
function calculateRetryDelay(retryAttempt: number, config: { maxRetryDelayInMs: number, retryDelayInMs: number }): { retryAfterInMs: number }
Parâmetros
- retryAttempt
-
number
O número de tentativa de repetição atual.
- config
-
{ maxRetryDelayInMs: number, retryDelayInMs: number }
A configuração de repetição exponencial.
Retornos
{ retryAfterInMs: number }
Um objeto que contém o atraso de repetição calculado.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })
wrapper promise.race() que anula o resto das promessas assim que a primeira promessa se estabelece.
function cancelablePromiseRace<T>(abortablePromiseBuilders: AbortablePromiseBuilder<T[number]>[], options?: { abortSignal?: AbortSignalLike }): Promise<T[number]>
Parâmetros
- abortablePromiseBuilders
-
AbortablePromiseBuilder<T[number]>[]
- options
-
{ abortSignal?: AbortSignalLike }
Retornos
Promise<T[number]>
computeSha256Hash(string, "base64" | "hex")
Gera um hash SHA-256.
function computeSha256Hash(content: string, encoding: "base64" | "hex"): Promise<string>
Parâmetros
- content
-
string
Os dados a serem incluídos no hash.
- encoding
-
"base64" | "hex"
A codificação textual a ser usada para o hash retornado.
Retornos
Promise<string>
computeSha256Hmac(string, string, "base64" | "hex")
Gera uma assinatura HMAC SHA-256.
function computeSha256Hmac(key: string, stringToSign: string, encoding: "base64" | "hex"): Promise<string>
Parâmetros
- key
-
string
A chave HMAC representada como uma cadeia de caracteres base64, usada para gerar o hash HMAC criptográfico.
- stringToSign
-
string
Os dados a serem assinados.
- encoding
-
"base64" | "hex"
A codificação textual a ser usada para o resumo HMAC retornado.
Retornos
Promise<string>
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)
Cria uma promessa anulável.
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
Uma função que usa a resolução e a rejeição de funções como parâmetros.
- options
- CreateAbortablePromiseOptions
As opções para a promessa anulável.
Retornos
Promise<T>
Uma promessa que pode ser anulada.
delay(number, DelayOptions)
Um wrapper para setTimeout que resolve uma promessa após milissegundos timeInMs.
function delay(timeInMs: number, options?: DelayOptions): Promise<void>
Parâmetros
- timeInMs
-
number
O número de milissegundos a serem atrasados.
- options
- DelayOptions
As opções de atraso – opções de anulação no momento
Retornos
Promise<void>
Promessa que é resolvida após timeInMs
getErrorMessage(unknown)
Considerando o que se pensa ser um objeto de erro, retorne a mensagem, se possível. Se a mensagem estiver ausente, retornará uma versão em cadeia de caracteres da entrada.
function getErrorMessage(e: unknown): string
Parâmetros
- e
-
unknown
Algo lançado de um bloco de tentativas
Retornos
string
A mensagem de erro ou uma cadeia de caracteres da entrada
getRandomIntegerInclusive(number, number)
Retorna um valor inteiro aleatório entre um limite inferior e superior, inclusive de ambos os limites. Observe que isso usa Math.random e não é seguro. Se você precisar usá-lo para qualquer tipo de finalidade de segurança, encontre uma melhor fonte aleatória.
function getRandomIntegerInclusive(min: number, max: number): number
Parâmetros
- min
-
number
O menor valor inteiro permitido.
- max
-
number
O maior valor inteiro permitido.
Retornos
number
isDefined<T>(undefined | null | T)
O Helper TypeGuard verifica se algo está definido ou não.
function isDefined<T>(thing: undefined | null | T): thing
Parâmetros
- thing
-
undefined | null | T
Qualquer coisa
Retornos
thing
isError(unknown)
Typeguard para uma forma de objeto de erro (tem nome e mensagem)
function isError(e: unknown): e
Parâmetros
- e
-
unknown
Algo pego por uma cláusula catch.
Retornos
e
isObject(unknown)
Auxiliar para determinar quando uma entrada é um objeto JS genérico.
function isObject(input: unknown): input
Parâmetros
- input
-
unknown
Retornos
input
true quando a entrada é um tipo de objeto que não é nulo, Array, RegExp ou Date.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])
O Helper TypeGuard verifica se a entrada é um objeto com as propriedades especificadas.
function isObjectWithProperties<Thing, PropertyName>(thing: Thing, properties: PropertyName[]): thing
Parâmetros
- thing
-
Thing
Qualquer coisa.
- properties
-
PropertyName[]
O nome das propriedades que devem aparecer no objeto.
Retornos
thing
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)
O Helper TypeGuard verifica se a entrada é um objeto com a propriedade especificada.
function objectHasProperty<Thing, PropertyName>(thing: Thing, property: PropertyName): thing
Parâmetros
- thing
-
Thing
Qualquer objeto.
- property
-
PropertyName
O nome da propriedade que deve aparecer no objeto.
Retornos
thing
randomUUID()
Identificador Universalmente Exclusivo Gerado
function randomUUID(): string
Retornos
string
RFC4122 UUID v4.
stringToUint8Array(string, EncodingType)
O auxiliar que transforma a cadeia de caracteres em uma matriz de bytes codificada por caractere específico.
function stringToUint8Array(value: string, format: EncodingType): Uint8Array
Parâmetros
- value
-
string
a cadeia de caracteres a ser convertida
- format
- EncodingType
o formato que usamos para decodificar o valor
Retornos
Uint8Array
a uint8array
uint8ArrayToString(Uint8Array, EncodingType)
O auxiliar que transforma bytes com codificação de caractere específica em cadeia de caracteres
function uint8ArrayToString(bytes: Uint8Array, format: EncodingType): string
Parâmetros
- bytes
-
Uint8Array
os bytes uint8array
- format
- EncodingType
o formato que usamos para codificar o byte
Retornos
string
uma cadeia de caracteres da cadeia de caracteres codificada