PollerLike interface

الحزمة:

@azure/core-lro

استقصاء لعملية ما.

يمتد

Promise<TResult>

الخصائص

isDone	يكون صحيحا إذا انتهى الاستقصاء من الاستقصاء.
operationState	حالة العملية. يمكن أن يكون غير محدد إذا لم يتم تقديم الاستقصاء بعد.
result	قيمة نتيجة العملية، بغض النظر عن حالة الاستقصاء. يمكن أن تكون غير معرفة أو شكل غير مكتمل من قيمة TResult النهائية اعتمادا على التنفيذ.

الخصائص الموروثة

[toStringTag]

الأساليب

onProgress((state: TState) => void)	استدعاء رد الاتصال المتوفر بعد اكتمال كل استقصاء، وإرسال الحالة الحالية لعملية الاستقصاء. يقوم بإرجاع أسلوب يمكن استخدامه لإيقاف تلقي التحديثات على دالة رد الاتصال المحددة.
poll({ abortSignal?: AbortSignalLike })	إرجاع وعد سيتم حله بمجرد انتهاء طلب استقصاء واحد. يقوم بذلك عن طريق استدعاء أسلوب التحديث لعملية Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })	إرجاع وعد سيتم حله بمجرد اكتمال العملية الأساسية.
serialize()	إرجاع وعد يمكن استخدامه للإصدار المتسلسل من عملية الاستقصاء عن طريق استدعاء أسلوب تسلسل العملية.
submitted()	إرجاع وعد يمكن استخدامه للتحقق مما إذا كان قد تم إرسال الاستقصاء.

الأساليب المتوارثة

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)	إرفاق رد اتصال لرفض الوعد فقط.
finally(null | () => void)	إرفاق رد اتصال يتم استدعاؤه عند تسوية الوعد (تم الوفاء به أو رفضه). لا يمكن تعديل القيمة التي تم حلها من رد الاتصال.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)	إرفاق عمليات رد الاتصال للحل و/أو رفض الوعد.

تفاصيل الخاصية

isDone

يكون صحيحا إذا انتهى الاستقصاء من الاستقصاء.

isDone: boolean

قيمة الخاصية

boolean

operationState

حالة العملية. يمكن أن يكون غير محدد إذا لم يتم تقديم الاستقصاء بعد.

operationState: undefined | TState

قيمة الخاصية

undefined | TState

result

قيمة نتيجة العملية، بغض النظر عن حالة الاستقصاء. يمكن أن تكون غير معرفة أو شكل غير مكتمل من قيمة TResult النهائية اعتمادا على التنفيذ.

result: undefined | TResult

قيمة الخاصية

undefined | TResult

تفاصيل الخاصية الموروثة

[toStringTag]

[toStringTag]: string

قيمة الخاصية

string

موروث من Promise.__@toStringTag@68

تفاصيل الأسلوب

onProgress((state: TState) => void)

استدعاء رد الاتصال المتوفر بعد اكتمال كل استقصاء، وإرسال الحالة الحالية لعملية الاستقصاء.

يقوم بإرجاع أسلوب يمكن استخدامه لإيقاف تلقي التحديثات على دالة رد الاتصال المحددة.

function onProgress(callback: (state: TState) => void): CancelOnProgress

المعلمات

callback

(state: TState) => void

المرتجعات

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

إرجاع وعد سيتم حله بمجرد انتهاء طلب استقصاء واحد. يقوم بذلك عن طريق استدعاء أسلوب التحديث لعملية Poller.

function poll(options?: { abortSignal?: AbortSignalLike }): Promise<TState>

المعلمات

options

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

إرجاع وعد سيتم حله بمجرد اكتمال العملية الأساسية.

function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>

المعلمات

pollOptions

{ abortSignal?: AbortSignalLike }

المرتجعات

Promise<TResult>

serialize()

إرجاع وعد يمكن استخدامه للإصدار المتسلسل من عملية الاستقصاء عن طريق استدعاء أسلوب تسلسل العملية.

function serialize(): Promise<string>

المرتجعات

Promise<string>

submitted()

إرجاع وعد يمكن استخدامه للتحقق مما إذا كان قد تم إرسال الاستقصاء.

function submitted(): Promise<void>

المرتجعات

Promise<void>

تفاصيل الأساليب المتوارثة

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

إرفاق رد اتصال لرفض الوعد فقط.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>

المعلمات

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

رد الاتصال الذي يجب تنفيذه عند رفض الوعد.

المرتجعات

Promise<TResult | TResult>

وعد بإكمال رد الاتصال.

موروث من Promise.catch

finally(null | () => void)

إرفاق رد اتصال يتم استدعاؤه عند تسوية الوعد (تم الوفاء به أو رفضه). لا يمكن تعديل القيمة التي تم حلها من رد الاتصال.

function finally(onfinally?: null | () => void): Promise<TResult>

المعلمات

onfinally

null | () => void

رد الاتصال الذي يجب تنفيذه عند تسوية الوعد (تم الوفاء به أو رفضه).

المرتجعات

Promise<TResult>

وعد بإكمال رد الاتصال.

موروثة من Promise.وأخيرا

then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

إرفاق عمليات رد الاتصال للحل و/أو رفض الوعد.

function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

المعلمات

onfulfilled

null | (value: TResult) => TResult1 | PromiseLike<TResult1>

رد الاتصال لتنفيذه عند حل الوعد.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

رد الاتصال الذي يجب تنفيذه عند رفض الوعد.

المرتجعات

Promise<TResult1 | TResult2>

وعد لإكمال أي رد اتصال يتم تنفيذه.

موروث من وعد.ثم