@azure/core-util package

الواجهات

AbortOptions	الخيارات المتعلقة بوحدة التحكم التي تم إجهاضها.
CreateAbortablePromiseOptions	خيارات الدالة createAbortablePromise.
DelayOptions	خيارات لدعم إحباط الوظيفة لأسلوب التأخير

النوع أسماء مستعارة

AbortablePromiseBuilder	يمثل دالة ترجع وعدا يمكن إجهاضه.
EncodingType	نوع ترميز الحرف المعتمد
HttpMethods	أساليب HTTP المدعومة لاستخدامها عند تقديم الطلبات.
UnknownObject	شكل عام لكائن JS عادي.

الوظائف

calculateRetryDelay(number, { maxRetryDelayInMs: number, retryDelayInMs: number })	حساب الفاصل الزمني للتأخير لمحاولات إعادة المحاولة باستخدام التأخير الأسي مع التشويه.
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)	المساعد الذي يحول وحدات البايت مع ترميز حرف معين إلى سلسلة

المتغيرات

isBrowser	ثابت يشير إلى ما إذا كانت البيئة التي يعمل عليها الكود هي متصفح ويب.
isBun	ثابت يشير إلى ما إذا كانت البيئة التي يدير الكود بها هي Bun.sh.
isDeno	ثابت يشير إلى ما إذا كانت البيئة التي يشغلها الكود هي Deno.
isNode	ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود بيئة متوافقة Node.js.
isNodeLike	ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود بيئة متوافقة Node.js.
isNodeRuntime	ثابت يشير إلى ما إذا كانت البيئة التي يعمل عليها الكود Node.JS.
isReactNative	ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود موجودة في React-Native.
isWebWorker	ثابت يشير إلى ما إذا كانت البيئة التي يشغلها الكود هي عامل ويب.

تفاصيل الوظيفة

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

حساب الفاصل الزمني للتأخير لمحاولات إعادة المحاولة باستخدام التأخير الأسي مع التشويه.

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>

الوعد الذي تم حله بعد timeInMs

getErrorMessage(unknown)

بالنظر إلى ما يعتقد أنه كائن خطأ، قم بإعادة الرسالة إذا كان ذلك ممكنا. إذا كانت الرسالة مفقودة، فترجع إصدارا سلسلة من الإدخال.

function getErrorMessage(e: unknown): string

المعلمات

e

unknown

شيء تم طرحه من كتلة محاولة

المرتجعات

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

صحيح عندما يكون الإدخال نوع كائن غير فارغ أو صفيف أو RegExp أو تاريخ.

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 v4.

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

سلسلة من السلسلة المشفرة

Variable Details

isBrowser

ثابت يشير إلى ما إذا كانت البيئة التي يعمل عليها الكود هي متصفح ويب.

isBrowser: boolean

النوع

boolean

isBun

ثابت يشير إلى ما إذا كانت البيئة التي يدير الكود بها هي Bun.sh.

isBun: boolean

النوع

boolean

isDeno

ثابت يشير إلى ما إذا كانت البيئة التي يشغلها الكود هي Deno.

isDeno: boolean

النوع

boolean

isNode

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Use isNodeLike instead.

ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود بيئة متوافقة Node.js.

isNode: boolean

النوع

boolean

isNodeLike

ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود بيئة متوافقة Node.js.

isNodeLike: boolean

النوع

boolean

isNodeRuntime

ثابت يشير إلى ما إذا كانت البيئة التي يعمل عليها الكود Node.JS.

isNodeRuntime: boolean

النوع

boolean

isReactNative

ثابت يشير إلى ما إذا كانت البيئة التي يعمل بها الكود موجودة في React-Native.

isReactNative: boolean

النوع

boolean

isWebWorker

ثابت يشير إلى ما إذا كانت البيئة التي يشغلها الكود هي عامل ويب.

isWebWorker: boolean

النوع

boolean