SimplePollerLike interface

Paket:
@azure/app-configuration

Poller sederhana yang dapat digunakan untuk melakukan polling operasi jangka panjang.

Antarmuka ini mencerminkan bentuk SimplePollerLike dari @azure/core-lro v2 sehingga permukaan API publik dipertahankan saat menggunakan poller v3 secara internal.

Metode

getOperationState()

Mengembalikan status operasi.
getResult()

Mengembalikan nilai hasil operasi, terlepas dari status poller. Ini dapat mengembalikan bentuk yang tidak ditentukan atau tidak lengkap dari nilai TResult akhir tergantung pada implementasinya.
isDone()

Mengembalikan true jika poller telah selesai melakukan polling.
isStopped()

Mengembalikan true jika poller dihentikan.
onProgress((state: TState) => void)

Memanggil callback yang disediakan setelah setiap polling selesai, mengirimkan status operasi poller saat ini.

Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi callback yang diberikan.
poll({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah satu permintaan polling selesai. Ini dilakukan dengan memanggil metode pembaruan operasi Poller.
pollUntilDone({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah operasi yang mendasarinya selesai.
stopPolling()

Menghentikan poller untuk melanjutkan pemungutan suara. Harap dicatat bahwa ini hanya akan menghentikan polling sisi klien
toString()

Mengembalikan representasi string dari operasi poller. Mirip dengan serialize tetapi mengembalikan string.

Detail Metode

getOperationState()

Mengembalikan status operasi.

function getOperationState(): TState

Mengembalikan

TState

getResult()

Mengembalikan nilai hasil operasi, terlepas dari status poller. Ini dapat mengembalikan bentuk yang tidak ditentukan atau tidak lengkap dari nilai TResult akhir tergantung pada implementasinya.

function getResult(): undefined | TResult

Mengembalikan

undefined | TResult

isDone()

Mengembalikan true jika poller telah selesai melakukan polling.

function isDone(): boolean

Mengembalikan

boolean

isStopped()

Mengembalikan true jika poller dihentikan.

function isStopped(): boolean

Mengembalikan

boolean

onProgress((state: TState) => void)

Memanggil callback yang disediakan setelah setiap polling selesai, mengirimkan status operasi poller saat ini.

Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi callback yang diberikan.

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

Parameter

callback

(state: TState) => void

Mengembalikan

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah satu permintaan polling selesai. Ini dilakukan dengan memanggil metode pembaruan operasi Poller.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<void>

pollUntilDone({ abortSignal?: AbortSignalLike })

Mengembalikan janji yang akan diselesaikan setelah operasi yang mendasarinya selesai.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<TResult>

stopPolling()

Menghentikan poller untuk melanjutkan pemungutan suara. Harap dicatat bahwa ini hanya akan menghentikan polling sisi klien

function stopPolling()

toString()

Mengembalikan representasi string dari operasi poller. Mirip dengan serialize tetapi mengembalikan string.

function toString(): string

Mengembalikan

string