Abstract representation of a poller, intended to expose just the minimal API that the user needs to work with.
Methods cancelOperation({ abortSignal?: AbortSignalLike })Attempts to cancel the underlying operation.
getOperationState()Returns the state of the operation. The TState defined in PollerLike can be a subset of the TState defined in the Poller implementation.
getResult()Returns the result value of the operation, regardless of the state of the poller. It can return undefined or an incomplete form of the final TResult value depending on the implementation.
isDone()Returns true if the poller has finished polling.
isStopped()Returns true if the poller is stopped.
onProgress((state: TState) => void)Invokes the provided callback after each polling is completed, sending the current state of the poller's operation.
It returns a method that can be used to stop receiving updates on the given callback function.
poll({ abortSignal?: AbortSignalLike })Returns a promise that will resolve once a single polling request finishes. It does this by calling the update method of the Poller's operation.
pollUntilDone({ abortSignal?: AbortSignalLike })Returns a promise that will resolve once the underlying operation is completed.
stopPolling()Stops the poller. After this, no manual or automated requests can be sent.
toString()Returns a serialized version of the poller's operation by invoking the operation's toString method.
Method Details cancelOperation({ abortSignal?: AbortSignalLike })Warning
This API is now deprecated.
cancelOperation has been deprecated because it was not implemented.
Attempts to cancel the underlying operation.
function cancelOperation(options?: { abortSignal?: AbortSignalLike }): Promise<void>{ abortSignal?: AbortSignalLike }
Promise<void>
getOperationState()Returns the state of the operation. The TState defined in PollerLike can be a subset of the TState defined in the Poller implementation.
function getOperationState(): TStateTState
getResult()Returns the result value of the operation, regardless of the state of the poller. It can return undefined or an incomplete form of the final TResult value depending on the implementation.
function getResult(): undefined | TResultundefined | TResult
isDone()Returns true if the poller has finished polling.
function isDone(): booleanboolean
isStopped()Returns true if the poller is stopped.
function isStopped(): booleanboolean
onProgress((state: TState) => void)Invokes the provided callback after each polling is completed, sending the current state of the poller's operation.
It returns a method that can be used to stop receiving updates on the given callback function.
function onProgress(callback: (state: TState) => void): CancelOnProgress(state: TState) => void
Returns a promise that will resolve once a single polling request finishes. It does this by calling the update method of the Poller's operation.
function poll(options?: { abortSignal?: AbortSignalLike }): Promise<void>{ abortSignal?: AbortSignalLike }
Promise<void>
pollUntilDone({ abortSignal?: AbortSignalLike })Returns a promise that will resolve once the underlying operation is completed.
function pollUntilDone(pollOptions?: { abortSignal?: AbortSignalLike }): Promise<TResult>{ abortSignal?: AbortSignalLike }
Promise<TResult>
stopPolling()Stops the poller. After this, no manual or automated requests can be sent.
function stopPolling()Returns a serialized version of the poller's operation by invoking the operation's toString method.
function toString(): stringstring
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4