PollerLike interface
Uzun süre çalışan bir işlemi yoklamada kullanılabilecek basit bir poller.
Yöntemler
| get |
İşlemin durumunu döndürür. |
| get |
Poller'ın durumundan bağımsız olarak işlemin sonuç değerini döndürür. Uygulamaya bağlı olarak son TResult değerinin tanımlanmamış veya tamamlanmamış bir biçimini döndürebilir. |
| is |
Poller yoklamayı bitirdiyse true döndürür. |
| is |
Poller durdurulursa true döndürür. |
| on |
Her yoklama tamamlandıktan sonra sağlanan geri çağırmayı çağırır ve poller işleminin geçerli durumunu gönderir. Verilen geri çağırma işlevinde güncelleştirmeleri almayı durdurmak için kullanılabilecek bir yöntem döndürür. |
| poll({ abort |
Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu, Poller'ın işleminin güncelleştirme yöntemini çağırarak yapar. |
| poll |
Temel alınan işlem tamamlandıktan sonra çözülecek bir söz döndürür. |
| stop |
Poller'ın ankete devam etmelerini durdurur. Bunun yalnızca istemci tarafı yoklamasını durduracağını lütfen unutmayın |
| to |
Poller'ın işleminin dize gösterimini döndürür. Serileştirmeye benzer ancak bir dize döndürür. |
Yöntem Ayrıntıları
getOperationState()
İşlemin durumunu döndürür.
function getOperationState(): TState
Döndürülenler
TState
getResult()
Poller'ın durumundan bağımsız olarak işlemin sonuç değerini döndürür. Uygulamaya bağlı olarak son TResult değerinin tanımlanmamış veya tamamlanmamış bir biçimini döndürebilir.
function getResult(): undefined | TResult
Döndürülenler
undefined | TResult
isDone()
Poller yoklamayı bitirdiyse true döndürür.
function isDone(): boolean
Döndürülenler
boolean
isStopped()
Poller durdurulursa true döndürür.
function isStopped(): boolean
Döndürülenler
boolean
onProgress((state: TState) => void)
Her yoklama tamamlandıktan sonra sağlanan geri çağırmayı çağırır ve poller işleminin geçerli durumunu gönderir.
Verilen geri çağırma işlevinde güncelleştirmeleri almayı durdurmak için kullanılabilecek bir yöntem döndürür.
function onProgress(callback: (state: TState) => void): CancelOnProgress
Parametreler
- callback
-
(state: TState) => void
Döndürülenler
poll({ abortSignal?: AbortSignalLike })
Tek bir yoklama isteği tamamlandığında çözülecek bir söz döndürür. Bunu, Poller'ın işleminin güncelleştirme yöntemini çağırarak yapar.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parametreler
- options
-
{ abortSignal?: AbortSignalLike }
Döndürülenler
Promise<void>
pollUntilDone({ abortSignal?: AbortSignalLike })
Temel alınan işlem tamamlandıktan sonra çözülecek bir söz döndürür.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>
Parametreler
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Döndürülenler
Promise<TResult>
stopPolling()
Poller'ın ankete devam etmelerini durdurur. Bunun yalnızca istemci tarafı yoklamasını durduracağını lütfen unutmayın
function stopPolling()
toString()
Poller'ın işleminin dize gösterimini döndürür. Serileştirmeye benzer ancak bir dize döndürür.
function toString(): string
Döndürülenler
string