SimplePollerLike interface
Een eenvoudige poller-interface.
Methoden
get |
Retourneert de status van de bewerking. |
get |
Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan een niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie. |
is |
Retourneert true als de poller de polling heeft voltooid. |
is |
Retourneert true als de poller is gestopt. |
on |
Roept de opgegeven callback aan nadat elke polling is voltooid, waarbij de huidige status van de bewerking van de poller wordt verzonden. Het retourneert een methode die kan worden gebruikt om het ontvangen van updates voor de opgegeven callback-functie te stoppen. |
poll({ abort |
Retourneert een belofte die wordt opgelost zodra één polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen. |
poll |
Retourneert een belofte die wordt omgezet zodra de onderliggende bewerking is voltooid. |
stop |
Stopt de poller. Daarna kunnen er geen handmatige of geautomatiseerde aanvragen meer worden verzonden. |
to |
Retourneert een geserialiseerde versie van de poller-bewerking door de methode toString van de bewerking aan te roepen. |
Methodedetails
getOperationState()
Retourneert de status van de bewerking.
function getOperationState(): TState
Retouren
TState
getResult()
Retourneert de resultaatwaarde van de bewerking, ongeacht de status van de poller. Het kan een niet-gedefinieerde of onvolledige vorm van de uiteindelijke TResult-waarde retourneren, afhankelijk van de implementatie.
function getResult(): undefined | TResult
Retouren
undefined | TResult
isDone()
Retourneert true als de poller de polling heeft voltooid.
function isDone(): boolean
Retouren
boolean
isStopped()
Retourneert true als de poller is gestopt.
function isStopped(): boolean
Retouren
boolean
onProgress((state: TState) => void)
Roept de opgegeven callback aan nadat elke polling is voltooid, waarbij de huidige status van de bewerking van de poller wordt verzonden.
Het retourneert een methode die kan worden gebruikt om het ontvangen van updates voor de opgegeven callback-functie te stoppen.
function onProgress(callback: (state: TState) => void): CancelOnProgress
Parameters
- callback
-
(state: TState) => void
Retouren
poll({ abortSignal?: AbortSignalLike })
Retourneert een belofte die wordt opgelost zodra één polling-aanvraag is voltooid. Dit doet u door de updatemethode van de poller-bewerking aan te roepen.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>
Parameters
- options
-
{ abortSignal?: AbortSignalLike }
Retouren
Promise<void>
pollUntilDone({ abortSignal?: AbortSignalLike })
Retourneert een belofte die wordt omgezet zodra de onderliggende bewerking is voltooid.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>
Parameters
- pollOptions
-
{ abortSignal?: AbortSignalLike }
Retouren
Promise<TResult>
stopPolling()
Stopt de poller. Daarna kunnen er geen handmatige of geautomatiseerde aanvragen meer worden verzonden.
function stopPolling()
toString()
Retourneert een geserialiseerde versie van de poller-bewerking door de methode toString van de bewerking aan te roepen.
function toString(): string
Retouren
string