PollerLike interface

Tente d’annuler l’opération sous-jacente.

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

Paramètres

Retours

Retourne l’état de l’opération. Le TState défini dans PollerLike peut être un sous-ensemble du TState défini dans l’implémentation poller.

function getOperationState(): TState

Retours

Retourne la valeur de résultat de l’opération, quel que soit l’état de l’polleur. Elle peut retourner une forme non définie ou incomplète de la valeur TResult finale en fonction de l’implémentation.

function getResult(): undefined | TResult

Retours

Retourne true si l’interrogation a terminé l’interrogation.

function isDone(): boolean

Retours

Retourne true si l’polleur est arrêté.

function isStopped(): boolean

Retours

Appelle le rappel fourni une fois chaque interrogation terminée, en envoyant l’état actuel de l’opération du polleur.

Elle retourne une méthode qui peut être utilisée pour arrêter la réception des mises à jour sur la fonction de rappel donnée.

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

Paramètres

Retours

Retourne une promesse qui se résout une fois qu’une seule demande d’interrogation est terminée. Pour ce faire, il appelle la méthode de mise à jour de l’opération Poller.

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

Paramètres

Retours

Retourne une promesse qui se résout une fois l’opération sous-jacente terminée.

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

Paramètres

Retours

Arrête l’polleur. Après cela, aucune demande manuelle ou automatisée ne peut être envoyée.

function stopPolling()

Retourne une version sérialisée de l’opération du polleur en appelant la méthode toString de l’opération.

function toString(): string

Retours