PollerLikeWithCancellation interface

Försöker avbryta den underliggande åtgärden.

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

Parametrar

Returer

Returnerar åtgärdens tillstånd. TState som definieras i PollerLike kan vara en delmängd av den TState som definierats i Poller-implementeringen.

function getOperationState(): TState

Returer

Returnerar åtgärdens resultatvärde, oavsett pollerarens tillstånd. Den kan returnera odefinierad eller ofullständig form av det slutliga TResult-värdet beroende på implementeringen.

function getResult(): undefined | TResult

Returer

Returnerar sant om polleraren har slutfört avsökningen.

function isDone(): boolean

Returer

Returnerar sant om polleraren stoppas.

function isStopped(): boolean

Returer

Anropar det angivna återanropet efter att varje avsökning har slutförts och skickar det aktuella tillståndet för pollerns åtgärd.

Den returnerar en metod som kan användas för att sluta ta emot uppdateringar för den angivna återanropsfunktionen.

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

Parametrar

Returer

Returnerar ett löfte som löser när en enskild avsökningsbegäran har slutförts. Det gör den genom att anropa uppdateringsmetoden för Poller-åtgärden.

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

Parametrar

Returer

Returnerar ett löfte som kommer att lösas när den underliggande åtgärden har slutförts.

function pollUntilDone(): Promise<TResult>

Returer

Stoppar polleraren. Efter detta kan inga manuella eller automatiserade begäranden skickas.

function stopPolling()

Returnerar en serialiserad version av pollerns åtgärd genom att anropa åtgärdens toString-metod.

function toString(): string

Returer