@azure/core-util package

Antarmuka

AbortOptions	Opsi yang terkait dengan batalkan pengontrol.
CreateAbortablePromiseOptions	Opsi untuk fungsi createAbortablePromise.
DelayOptions	Opsi untuk dukungan membatalkan fungsionalitas untuk metode penundaan

Alias Jenis

AbortablePromiseBuilder	Mewakili fungsi yang mengembalikan janji yang dapat dibatalkan.
EncodingType	Jenis pengodean karakter yang didukung
HttpMethods	Metode HTTP yang didukung untuk digunakan saat membuat permintaan.
UnknownObject	Bentuk generik untuk objek JS biasa.

Fungsi

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	Menghitung interval penundaan untuk upaya coba lagi menggunakan penundaan eksponensial dengan jitter.
cancelablePromiseRace<T>(AbortablePromiseBuilder<T[number]>[], { abortSignal?: AbortSignalLike })	pembungkus promise.race() yang membatalkan sisa janji segera setelah janji pertama selesai.
computeSha256Hash(string, "base64" | "hex")	Menghasilkan hash SHA-256.
computeSha256Hmac(string, string, "base64" | "hex")	Menghasilkan tanda tangan SHA-256 HMAC.
createAbortablePromise<T>((resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void, CreateAbortablePromiseOptions)	Membuat janji yang dapat dibatalkan.
delay(number, DelayOptions)	Pembungkus untuk setTimeout yang menyelesaikan janji setelah milidetik timeInMs.
getErrorMessage(unknown)	Mengingat apa yang dianggap sebagai objek kesalahan, kembalikan pesan jika memungkinkan. Jika pesan hilang, mengembalikan versi input yang di string.
getRandomIntegerInclusive(number, number)	Mengembalikan nilai bilangan bulat acak antara batas bawah dan atas, termasuk kedua batas. Perhatikan bahwa ini menggunakan Math.random dan tidak aman. Jika Anda perlu menggunakan ini untuk tujuan keamanan apa pun, temukan sumber acak yang lebih baik.
isDefined<T>(undefined | null | T)	Helper TypeGuard yang memeriksa apakah ada sesuatu yang ditentukan atau tidak.
isError(unknown)	Typeguard untuk bentuk objek kesalahan (memiliki nama dan pesan)
isObject(unknown)	Pembantu untuk menentukan kapan input adalah objek JS generik.
isObjectWithProperties<Thing, PropertyName>(Thing, PropertyName[])	Helper TypeGuard yang memeriksa apakah input adalah objek dengan properti yang ditentukan.
objectHasProperty<Thing, PropertyName>(Thing, PropertyName)	Helper TypeGuard yang memeriksa apakah input adalah objek dengan properti yang ditentukan.
randomUUID()	Pengidentifikasi Unik Universal yang Dihasilkan
stringToUint8Array(string, EncodingType)	Pembantu yang mengubah string ke array byte yang dikodekan karakter tertentu.
uint8ArrayToString(Uint8Array, EncodingType)	Pembantu yang mengubah byte dengan pengodean karakter tertentu menjadi string

Variabel

isBrowser	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Browser Web.
isBun	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Bun.sh.
isDeno	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Deno.
isNode	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah lingkungan yang kompatibel dengan Node.js.
isNodeLike	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah lingkungan yang kompatibel dengan Node.js.
isNodeRuntime	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Node.JS.
isReactNative	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode berada dalam React-Native.
isWebWorker	Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Web Worker.

Detail Fungsi

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

Menghitung interval penundaan untuk upaya coba lagi menggunakan penundaan eksponensial dengan jitter.

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

Parameter

retryAttempt

number

Nomor upaya coba lagi saat ini.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Konfigurasi coba lagi eksponensial.

Mengembalikan

{ retryAfterInMs: number }

Objek yang berisi penundaan coba lagi yang dihitung.

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

pembungkus promise.race() yang membatalkan sisa janji segera setelah janji pertama selesai.

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

Parameter

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<T[number]>

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

Menghasilkan hash SHA-256.

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

Parameter

content

string

Data yang akan disertakan dalam hash.

encoding

"base64" | "hex"

Pengodean tekstual yang digunakan untuk hash yang dikembalikan.

Mengembalikan

Promise<string>

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

Menghasilkan tanda tangan SHA-256 HMAC.

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

Parameter

key

string

Kunci HMAC diwakili sebagai string base64, digunakan untuk menghasilkan hash HMAC kriptografi.

stringToSign

string

Data yang akan ditandatangani.

encoding

"base64" | "hex"

Pengodean tekstual yang digunakan untuk hash HMAC yang dikembalikan.

Mengembalikan

Promise<string>

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

Membuat janji yang dapat dibatalkan.

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

Fungsi yang mengambil fungsi penyelesaian dan penolakan sebagai parameter.

options

CreateAbortablePromiseOptions

Opsi untuk janji yang dapat dibatalkan.

Mengembalikan

Promise<T>

Sebuah janji yang dapat dibatalkan.

delay(number, DelayOptions)

Pembungkus untuk setTimeout yang menyelesaikan janji setelah milidetik timeInMs.

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

Parameter

timeInMs

number

Jumlah milidetik yang akan ditunda.

options

DelayOptions

Opsi untuk penundaan - opsi yang saat ini dibatalkan

Mengembalikan

Promise<void>

Janji yang diselesaikan setelah timeInMs

getErrorMessage(unknown)

Mengingat apa yang dianggap sebagai objek kesalahan, kembalikan pesan jika memungkinkan. Jika pesan hilang, mengembalikan versi input yang di string.

function getErrorMessage(e: unknown): string

Parameter

e

unknown

Sesuatu yang dilemparkan dari blok percobaan

Mengembalikan

string

Pesan kesalahan atau string input

getRandomIntegerInclusive(number, number)

Mengembalikan nilai bilangan bulat acak antara batas bawah dan atas, termasuk kedua batas. Perhatikan bahwa ini menggunakan Math.random dan tidak aman. Jika Anda perlu menggunakan ini untuk tujuan keamanan apa pun, temukan sumber acak yang lebih baik.

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

Parameter

min

number

Nilai bilangan bulat terkecil yang diizinkan.

max

number

Nilai bilangan bulat terbesar yang diizinkan.

Mengembalikan

number

isDefined<T>(undefined | null | T)

Helper TypeGuard yang memeriksa apakah ada sesuatu yang ditentukan atau tidak.

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

Parameter

thing

undefined | null | T

Apa-apa

Mengembalikan

thing

isError(unknown)

Typeguard untuk bentuk objek kesalahan (memiliki nama dan pesan)

function isError(e: unknown): e

Parameter

e

unknown

Sesuatu tertangkap oleh klausul tangkapan.

Mengembalikan

e

isObject(unknown)

Pembantu untuk menentukan kapan input adalah objek JS generik.

function isObject(input: unknown): input

Parameter

input

unknown

Mengembalikan

input

true ketika input adalah jenis objek yang bukan null, Array, RegExp, atau Date.

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

Helper TypeGuard yang memeriksa apakah input adalah objek dengan properti yang ditentukan.

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

Parameter

thing

Thing

Apa-apa.

properties

PropertyName[]

Nama properti yang akan muncul di objek .

Mengembalikan

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Helper TypeGuard yang memeriksa apakah input adalah objek dengan properti yang ditentukan.

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

Parameter

thing

Thing

Objek apa pun.

property

PropertyName

Nama properti yang akan muncul di objek.

Mengembalikan

thing

randomUUID()

Pengidentifikasi Unik Universal yang Dihasilkan

function randomUUID(): string

Mengembalikan

string

RFC4122 UUID v4.

stringToUint8Array(string, EncodingType)

Pembantu yang mengubah string ke array byte yang dikodekan karakter tertentu.

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

Parameter

value

string

string yang akan dikonversi

format

EncodingType

format yang kita gunakan untuk mendekode nilai

Mengembalikan

Uint8Array

uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Pembantu yang mengubah byte dengan pengodean karakter tertentu menjadi string

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

Parameter

bytes

Uint8Array

byte uint8array

format

EncodingType

format yang kita gunakan untuk mengodekan byte

Mengembalikan

string

string string yang dikodekan

Variable Details

isBrowser

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Browser Web.

isBrowser: boolean

Jenis

boolean

isBun

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Bun.sh.

isBun: boolean

Jenis

boolean

isDeno

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Deno.

isDeno: boolean

Jenis

boolean

isNode

Peringatan

API ini sudah tidak digunakan lagi.

Use isNodeLike instead.

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah lingkungan yang kompatibel dengan Node.js.

isNode: boolean

Jenis

boolean

isNodeLike

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah lingkungan yang kompatibel dengan Node.js.

isNodeLike: boolean

Jenis

boolean

isNodeRuntime

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Node.JS.

isNodeRuntime: boolean

Jenis

boolean

isReactNative

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode berada dalam React-Native.

isReactNative: boolean

Jenis

boolean

isWebWorker

Konstanta yang menunjukkan apakah lingkungan yang dijalankan kode adalah Web Worker.

isWebWorker: boolean

Jenis

boolean