@azure/core-util package

Интерфейсы

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

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

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

Функции

cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	оболочка promise.race(), которая прерывает остальные обещания, как только первое обещание оседает.
computeSha256Hash(string, "base64" | "hex")	Создает хэш SHA-256.
computeSha256Hmac(string, string, "base64" | "hex")	Создает подпись HMAC SHA-256.
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)	Вспомогательный TypeGuard, который проверяет, определено ли что-либо.
isError(unknown)	Typeguard для фигуры объекта ошибки (имеет имя и сообщение)
isObject(unknown)	Вспомогательное средство для определения того, когда входные данные являются универсальным объектом JS.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Вспомогательный typeGuard, который проверяет, является ли вход объектом с указанными свойствами.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Вспомогательный typeGuard, который проверяет, является ли вход объектом с указанным свойством.
randomUUID()	Созданный универсальный уникальный идентификатор
stringToUint8Array(string, EncodingType)	Вспомогатель, преобразующий строку в определенный массив байтов в кодировке символов.
uint8ArrayToString(Uint8Array, EncodingType)	Вспомогатель, преобразующий байты с определенной кодировкой символов в строку

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

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")

Создает подпись HMAC SHA-256.

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)

Вспомогательный 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[])

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

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

Параметры

thing

Thing

Любое.

properties

PropertyName[]

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

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

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Вспомогательный 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

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