@azure/core-util package

Интерфейсы

AbortOptions	Параметры, связанные с контроллером прерывания.
CreateAbortablePromiseOptions	Параметры функции createAbortablePromise.
DelayOptions	Параметры поддержки прерывания для метода задержки

Псевдонимы типа

AbortablePromiseBuilder	Представляет функцию, которая возвращает обещание, которое может быть прервано.
EncodingType	Поддерживаемый тип кодировки символов
HttpMethods	Поддерживаемые методы HTTP для использования при выполнении запросов.
UnknownObject	Универсальная фигура для обычного объекта JS.

Функции

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Вычисляет интервал задержки для повторных попыток с экспоненциальной задержкой с jitter.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	promise.race() оболочка, которая прерывает остальные обещания, как только первое обещание поселится.
computeSha256Hash(string, "base64" | "hex")	Создает хэш SHA-256.
computeSha256Hmac(string, string, "base64" | "hex")	Создает сигнатуру SHA-256 HMAC.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Создает прерваемое обещание.
delay(number, DelayOptions)	Оболочка для setTimeout, которая разрешает обещание после миллисекундах timeInMs.
getErrorMessage(unknown)	Учитывая, что считается объектом ошибки, возвращает сообщение, если это возможно. Если сообщение отсутствует, возвращает строковую версию входных данных.
getRandomIntegerInclusive(number, number)	Возвращает случайное целое значение между нижней и верхней границами, включающее обе границы. Обратите внимание, что это использует Math.random и не является безопасным. Если вам нужно использовать это для любой цели безопасности, найдите лучший источник случайного.
isDefined<T>(undefined | null | T)	Helper TypeGuard, который проверяет, определен ли что-то или нет.
isError(unknown)	Typeguard для фигуры объекта ошибки (имеет имя и сообщение)
isObject(unknown)	Вспомогательный элемент, определяющий, когда входные данные являются универсальным объектом JS.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Helper TypeGuard, который проверяет, является ли вход объектом с указанными свойствами.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Helper TypeGuard, который проверяет, является ли вход объектом с указанным свойством.
randomUUID()	Созданный универсальный уникальный идентификатор
stringToUint8Array(string, EncodingType)	Вспомогательный элемент, который преобразует строку в определенный массив байтов в кодировке символов.
uint8ArrayToString(Uint8Array, EncodingType)	Вспомогательный элемент, который преобразует байты с определенной кодировкой символов в строку

Сведения о функции

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

Вычисляет интервал задержки для повторных попыток с экспоненциальной задержкой с jitter.

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

Параметры

retryAttempt

number

Текущий номер попытки повтора.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Экспоненциальная конфигурация повторных попыток.

Возвращаемое значение

{ retryAfterInMs: number }

Объект, содержащий вычисляемую задержку повторных попыток.

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

promise.race() оболочка, которая прерывает остальные обещания, как только первое обещание поселится.

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

Параметры

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Возвращаемое значение

Promise<T[number]>

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

Создает хэш SHA-256.

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

Параметры

content

string

Данные, которые необходимо включить в хэш.

encoding

"base64" | "hex"

Текстовая кодировка, используемая для возвращаемого хэша.

Возвращаемое значение

Promise<string>

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

Создает сигнатуру SHA-256 HMAC.

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

Параметры

key

string

Ключ HMAC, представленный как строка base64, используемая для создания хэша криптографического HMAC.

stringToSign

string

Подписанные данные.

encoding

"base64" | "hex"

Текстовая кодировка, используемая для возвращаемого дайджеста HMAC.

Возвращаемое значение

Promise<string>

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

Создает прерваемое обещание.

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

Параметры

buildPromise

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

Функция, которая принимает функции разрешения и отклонения в качестве параметров.

options

CreateAbortablePromiseOptions

Варианты прерваемого обещания.

Возвращаемое значение

Promise<T>

Обещание, которое может быть прервано.

delay(number, DelayOptions)

Оболочка для setTimeout, которая разрешает обещание после миллисекундах timeInMs.

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

Параметры

timeInMs

number

Число отложенных миллисекундах.

options

DelayOptions

Параметры задержки — в настоящее время параметры прерывания

Возвращаемое значение

Promise<void>

Обещание, которое разрешается после времениInMs

getErrorMessage(unknown)

Учитывая, что считается объектом ошибки, возвращает сообщение, если это возможно. Если сообщение отсутствует, возвращает строковую версию входных данных.

function getErrorMessage(e: unknown): string

Параметры

e

unknown

Что-то выброшено из блока try

Возвращаемое значение

string

Сообщение об ошибке или строка входных данных

getRandomIntegerInclusive(number, number)

Возвращает случайное целое значение между нижней и верхней границами, включающее обе границы. Обратите внимание, что это использует Math.random и не является безопасным. Если вам нужно использовать это для любой цели безопасности, найдите лучший источник случайного.

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

Параметры

min

number

Наименьшее допустимое целочисленное значение.

max

number

Максимально допустимое целочисленное значение.

Возвращаемое значение

number

isDefined<T>(undefined | null | T)

Helper TypeGuard, который проверяет, определен ли что-то или нет.

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

Параметры

thing

undefined | null | T

Что-нибудь

Возвращаемое значение

thing

isError(unknown)

Typeguard для фигуры объекта ошибки (имеет имя и сообщение)

function isError(e: unknown): e

Параметры

e

unknown

Что-то поймано предложением catch.

Возвращаемое значение

e

isObject(unknown)

Вспомогательный элемент, определяющий, когда входные данные являются универсальным объектом JS.

function isObject(input: unknown): input

Параметры

input

unknown

Возвращаемое значение

input

True, если входные данные — это тип объекта, который не имеет значения NULL, Array, RegExp или Date.

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

Helper TypeGuard, который проверяет, является ли вход объектом с указанными свойствами.

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

Параметры

thing

Thing

Что-нибудь.

properties

PropertyName[]

Имя свойств, которые должны отображаться в объекте.

Возвращаемое значение

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard, который проверяет, является ли вход объектом с указанным свойством.

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

Параметры

thing

Thing

Любой объект.

property

PropertyName

Имя свойства, которое должно отображаться в объекте.

Возвращаемое значение

thing

randomUUID()

Созданный универсальный уникальный идентификатор

function randomUUID(): string

Возвращаемое значение

string

RFC4122 UUID версии 4.

stringToUint8Array(string, EncodingType)

Вспомогательный элемент, который преобразует строку в определенный массив байтов в кодировке символов.

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

Параметры

value

string

строка, которая будет преобразована

format

EncodingType

формат, используемый для декодирования значения

Возвращаемое значение

Uint8Array

uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Вспомогательный элемент, который преобразует байты с определенной кодировкой символов в строку

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

Параметры

bytes

Uint8Array

байты uint8array

format

EncodingType

Формат, используемый для кодирования байтов

Возвращаемое значение

string

строка закодированной строки