PollerLike interface

Paket:

@azure/keyvault-keys

Representasi abstrak dari poller, dimaksudkan untuk mengekspos API minimal yang perlu dikerjakan pengguna.

Metode

cancelOperation({ abortSignal?: AbortSignalLike })	Mencoba membatalkan operasi yang mendasar.
getOperationState()	Mengembalikan status operasi. TState yang ditentukan dalam PollerLike dapat menjadi subset dari TState yang ditentukan dalam implementasi Poller.
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 panggilan balik yang disediakan setelah setiap polling selesai, mengirim status operasi poller saat ini. Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi panggilan balik 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 mendasar selesai.
stopPolling()	Menghentikan poller. Setelah ini, tidak ada permintaan manual atau otomatis yang dapat dikirim.
toString()	Mengembalikan versi berseri operasi poller dengan memanggil metode toString operasi.

Detail Metode

cancelOperation({ abortSignal?: AbortSignalLike })

Peringatan

API ini sudah tidak digunakan lagi.

cancelOperation has been deprecated because it was not implemented.

Mencoba membatalkan operasi yang mendasar.

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

Parameter

options

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<void>

getOperationState()

Mengembalikan status operasi. TState yang ditentukan dalam PollerLike dapat menjadi subset dari TState yang ditentukan dalam implementasi Poller.

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 panggilan balik yang disediakan setelah setiap polling selesai, mengirim status operasi poller saat ini.

Ini mengembalikan metode yang dapat digunakan untuk berhenti menerima pembaruan pada fungsi panggilan balik 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 mendasar selesai.

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

Parameter

pollOptions

{ abortSignal?: AbortSignalLike }

Mengembalikan

Promise<TResult>

stopPolling()

Menghentikan poller. Setelah ini, tidak ada permintaan manual atau otomatis yang dapat dikirim.

function stopPolling()

toString()

Mengembalikan versi berseri operasi poller dengan memanggil metode toString operasi.

function toString(): string

Mengembalikan

string