Aracılığıyla paylaş


@azure/core-util package

Arabirimler

AbortOptions

Durdurma denetleyicisiyle ilgili seçenekler.

CreateAbortablePromiseOptions

createAbortablePromise işlevi seçenekleri.

DelayOptions

Gecikme yöntemi için destek durdurma işlevselliği seçenekleri

Tür Diğer Adları

AbortablePromiseBuilder

Durdurulabilecek bir promise döndüren bir işlevi temsil eder.

EncodingType

Desteklenen karakter kodlama türü

HttpMethods

İstekte bulunurken kullanılacak HTTP yöntemleri destekleniyor.

UnknownObject

Düz JS nesnesi için genel bir şekil.

İşlevler

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

Değişimli üstel gecikmeyi kullanarak yeniden deneme girişimleri için gecikme aralığını hesaplar.

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

promise.race() sarmalayıcısı, ilk söz tamamlandıkça kalan vaatleri iptal eder.

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

SHA-256 karması oluşturur.

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

SHA-256 HMAC imzası oluşturur.

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

Durdurulabilir bir söz oluşturur.

delay(number, DelayOptions)

timeInMs milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.

getErrorMessage(unknown)

Hata nesnesi olduğu düşünülen bir nesne varsa, mümkünse iletiyi döndür. İleti eksikse, girişin dizeli bir sürümünü döndürür.

getRandomIntegerInclusive(number, number)

Her iki sınır da dahil olmak üzere alt ve üst sınır arasında rastgele bir tamsayı değeri döndürür. Bunun Math.random kullandığını ve güvenli olmadığını unutmayın. Bunu herhangi bir güvenlik amacıyla kullanmanız gerekiyorsa daha iyi bir rastgele kaynak bulun.

isDefined<T>(undefined | null | T)

Bir şeyin tanımlandığını veya tanımlanmadığını denetleyen Yardımcı TypeGuard.

isError(unknown)

Hata nesnesi şekli için typeguard (adı ve iletisi var)

isObject(unknown)

Bir girişin genel bir JS nesnesi olduğunu saptamak için yardımcı.

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

Girişin belirtilen özelliklere sahip bir nesne olup olmadığını denetleen Yardımcı TypeGuard.

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Girişin belirtilen özelliğe sahip bir nesne olup olmadığını denetleen Yardımcı TypeGuard.

randomUUID()

Evrensel Olarak Benzersiz Tanımlayıcı Oluşturuldu

stringToUint8Array(string, EncodingType)

Dizeyi belirli karakter kodlanmış bayt dizisine dönüştüren yardımcı.

uint8ArrayToString(Uint8Array, EncodingType)

Belirli karakter kodlamalı baytları dizeye dönüştüren yardımcı

Değişkenler

isBrowser

Kodun çalıştığı ortamın bir Web Tarayıcısı olup olmadığını gösteren bir sabit.

isBun

Kodun çalıştığı ortamın Bun.sh olup olmadığını gösteren bir sabit.

isDeno

Kodun çalıştığı ortamın Deno olup olmadığını gösteren bir sabit.

isNode

Kodun çalıştığı ortamın Node.js uyumlu olup olmadığını gösteren bir sabit.

isNodeLike

Kodun çalıştığı ortamın Node.js uyumlu olup olmadığını gösteren bir sabit.

isNodeRuntime

Kodun çalıştığı ortamın Node.JS olup olmadığını gösteren bir sabit.

isReactNative

Kodun çalıştığı ortamın React-Native olup olmadığını gösteren bir sabit.

isWebWorker

Kodun çalıştığı ortamın Web Çalışanı olup olmadığını gösteren bir sabit.

İşlev Ayrıntıları

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

Değişimli üstel gecikmeyi kullanarak yeniden deneme girişimleri için gecikme aralığını hesaplar.

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

Parametreler

retryAttempt

number

Geçerli yeniden deneme deneme numarası.

config

{ maxRetryDelayInMs: number, retryDelayInMs: number }

Üstel yeniden deneme yapılandırması.

Döndürülenler

{ retryAfterInMs: number }

Hesaplanan yeniden deneme gecikmesini içeren bir nesne.

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

promise.race() sarmalayıcısı, ilk söz tamamlandıkça kalan vaatleri iptal eder.

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

Parametreler

abortablePromiseBuilders

AbortablePromiseBuilder<T[number]>[]

options

{ abortSignal?: AbortSignalLike }

Döndürülenler

Promise<T[number]>

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

SHA-256 karması oluşturur.

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

Parametreler

content

string

Karmaya dahil edilecek veriler.

encoding

"base64" | "hex"

Döndürülen karma için kullanılacak metin kodlaması.

Döndürülenler

Promise<string>

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

SHA-256 HMAC imzası oluşturur.

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

Parametreler

key

string

Şifreleme HMAC karması oluşturmak için kullanılan base64 dizesi olarak temsil edilen HMAC anahtarı.

stringToSign

string

İmzalanacak veriler.

encoding

"base64" | "hex"

Döndürülen HMAC özeti için kullanılacak metin kodlaması.

Döndürülenler

Promise<string>

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

Durdurulabilir bir söz oluşturur.

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

Parametreler

buildPromise

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

Çözümle ve reddet işlevlerini parametre olarak alan bir işlev.

options
CreateAbortablePromiseOptions

Durdurulabilir söz seçenekleri.

Döndürülenler

Promise<T>

Durdurulabilecek bir söz.

delay(number, DelayOptions)

timeInMs milisaniyeden sonra bir promise'i çözümleyen setTimeout için sarmalayıcı.

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

Parametreler

timeInMs

number

Ertelenecek milisaniye sayısı.

options
DelayOptions

Gecikme seçenekleri - şu anda iptal seçenekleri

Döndürülenler

Promise<void>

TimeInMs sonrasında çözümlenen söz

getErrorMessage(unknown)

Hata nesnesi olduğu düşünülen bir nesne varsa, mümkünse iletiyi döndür. İleti eksikse, girişin dizeli bir sürümünü döndürür.

function getErrorMessage(e: unknown): string

Parametreler

e

unknown

Deneme bloğundan bir şey oluştu

Döndürülenler

string

Hata iletisi veya girişin dizesi

getRandomIntegerInclusive(number, number)

Her iki sınır da dahil olmak üzere alt ve üst sınır arasında rastgele bir tamsayı değeri döndürür. Bunun Math.random kullandığını ve güvenli olmadığını unutmayın. Bunu herhangi bir güvenlik amacıyla kullanmanız gerekiyorsa daha iyi bir rastgele kaynak bulun.

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

Parametreler

min

number

İzin verilen en küçük tamsayı değeri.

max

number

İzin verilen en büyük tamsayı değeri.

Döndürülenler

number

isDefined<T>(undefined | null | T)

Bir şeyin tanımlandığını veya tanımlanmadığını denetleyen Yardımcı TypeGuard.

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

Parametreler

thing

undefined | null | T

Hiçbir şey

Döndürülenler

thing

isError(unknown)

Hata nesnesi şekli için typeguard (adı ve iletisi var)

function isError(e: unknown): e

Parametreler

e

unknown

Catch yan tümcesi tarafından yakalanan bir şey.

Döndürülenler

e

isObject(unknown)

Bir girişin genel bir JS nesnesi olduğunu saptamak için yardımcı.

function isObject(input: unknown): input

Parametreler

input

unknown

Döndürülenler

input

giriş null olmayan bir nesne türü olduğunda true, Array, RegExp veya Date.

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

Girişin belirtilen özelliklere sahip bir nesne olup olmadığını denetleen Yardımcı TypeGuard.

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

Parametreler

thing

Thing

Hiçbir şey.

properties

PropertyName[]

Nesnede görünmesi gereken özelliklerin adı.

Döndürülenler

thing

objectHasProperty<Thing, PropertyName>(Thing, PropertyName)

Girişin belirtilen özelliğe sahip bir nesne olup olmadığını denetleen Yardımcı TypeGuard.

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

Parametreler

thing

Thing

Herhangi bir nesne.

property

PropertyName

Nesnede görünmesi gereken özelliğin adı.

Döndürülenler

thing

randomUUID()

Evrensel Olarak Benzersiz Tanımlayıcı Oluşturuldu

function randomUUID(): string

Döndürülenler

string

RFC4122 v4 UUID.

stringToUint8Array(string, EncodingType)

Dizeyi belirli karakter kodlanmış bayt dizisine dönüştüren yardımcı.

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

Parametreler

value

string

dönüştürülecek dize

format
EncodingType

değerin kodunu çözmek için kullandığımız biçim

Döndürülenler

Uint8Array

bir uint8array

uint8ArrayToString(Uint8Array, EncodingType)

Belirli karakter kodlamalı baytları dizeye dönüştüren yardımcı

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

Parametreler

bytes

Uint8Array

uint8array baytları

format
EncodingType

baytını kodlamak için kullandığımız biçim

Döndürülenler

string

kodlanmış dizenin dizesi

Variable Details

isBrowser

Kodun çalıştığı ortamın bir Web Tarayıcısı olup olmadığını gösteren bir sabit.

isBrowser: boolean

Tür

boolean

isBun

Kodun çalıştığı ortamın Bun.sh olup olmadığını gösteren bir sabit.

isBun: boolean

Tür

boolean

isDeno

Kodun çalıştığı ortamın Deno olup olmadığını gösteren bir sabit.

isDeno: boolean

Tür

boolean

isNode

Uyarı

Bu API artık kullanım dışıdır.

Use isNodeLike instead.

Kodun çalıştığı ortamın Node.js uyumlu olup olmadığını gösteren bir sabit.

isNode: boolean

Tür

boolean

isNodeLike

Kodun çalıştığı ortamın Node.js uyumlu olup olmadığını gösteren bir sabit.

isNodeLike: boolean

Tür

boolean

isNodeRuntime

Kodun çalıştığı ortamın Node.JS olup olmadığını gösteren bir sabit.

isNodeRuntime: boolean

Tür

boolean

isReactNative

Kodun çalıştığı ortamın React-Native olup olmadığını gösteren bir sabit.

isReactNative: boolean

Tür

boolean

isWebWorker

Kodun çalıştığı ortamın Web Çalışanı olup olmadığını gösteren bir sabit.

isWebWorker: boolean

Tür

boolean