Dela via

PollerLike interface

  • Referens
Paket:
@azure/core-lro

En poller för en åtgärd.

Extends

Promise<TResult>

Egenskaper

isDone

Är sant om polleraren har slutfört avsökningen.
operationState

Åtgärdens tillstånd. Det kan vara odefinierat om pollern inte har skickats ännu.
result

Resultatvärdet för åtgärden, oavsett pollerns tillstånd. Det kan vara odefinierat eller en ofullständig form av det slutliga TResult-värdet beroende på implementeringen.

Ärvda egenskaper

[toStringTag]

Metoder

onProgress((state: TState) => void)

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.
poll({ abortSignal?: AbortSignalLike })

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.
pollUntilDone({ abortSignal?: AbortSignalLike })

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

Returnerar ett löfte som kan användas för serialiserad version av pollerns åtgärd genom att anropa åtgärdens serialiseringsmetod.
submitted()

Returnerar ett löfte som kan användas för att kontrollera om pollern har skickats.

Ärvda metoder

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Bifogar ett återanrop för att endast avvisa löftet.
finally(null | () => void)

Bifogar ett återanrop som anropas när löftet har avgjorts (uppfyllt eller avvisats). Det lösta värdet kan inte ändras från återanropet.
then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Bifogar återanrop för lösning och/eller avvisande av löftet.

Egenskapsinformation

isDone

Är sant om polleraren har slutfört avsökningen.

isDone: boolean

Egenskapsvärde

boolean

operationState

Åtgärdens tillstånd. Det kan vara odefinierat om pollern inte har skickats ännu.

operationState: undefined | TState

Egenskapsvärde

undefined | TState

result

Resultatvärdet för åtgärden, oavsett pollerns tillstånd. Det kan vara odefinierat eller en ofullständig form av det slutliga TResult-värdet beroende på implementeringen.

result: undefined | TResult

Egenskapsvärde

undefined | TResult

Information om ärvda egenskaper

[toStringTag] 

[toStringTag]: string

Egenskapsvärde

string

ärvd från Promise.__@toStringTag@68

Metodinformation

onProgress((state: TState) => void)

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

callback

(state: TState) => void

Returer

CancelOnProgress

poll({ abortSignal?: AbortSignalLike })

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<TState>

Parametrar

options

{ abortSignal?: AbortSignalLike }

Returer

Promise<TState>

pollUntilDone({ abortSignal?: AbortSignalLike })

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

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

Parametrar

pollOptions

{ abortSignal?: AbortSignalLike }

Returer

Promise<TResult>

serialize()

Returnerar ett löfte som kan användas för serialiserad version av pollerns åtgärd genom att anropa åtgärdens serialiseringsmetod.

function serialize(): Promise<string>

Returer

Promise<string>

submitted()

Returnerar ett löfte som kan användas för att kontrollera om pollern har skickats.

function submitted(): Promise<void>

Returer

Promise<void>

Ärvd metodinformation

catch<TResult>(null | (reason: any) => TResult | PromiseLike<TResult>)

Bifogar ett återanrop för att endast avvisa löftet.

function catch<TResult>(onrejected?: null | (reason: any) => TResult | PromiseLike<TResult>): Promise<TResult | TResult>

Parametrar

onrejected

null | (reason: any) => TResult | PromiseLike<TResult>

Återanropet som ska köras när Promise avvisas.

Returer

Promise<TResult | TResult>

Ett löfte om att återanropet ska slutföras.

ärvd från Promise.catch

finally(null | () => void)

Bifogar ett återanrop som anropas när löftet har avgjorts (uppfyllt eller avvisats). Det lösta värdet kan inte ändras från återanropet.

function finally(onfinally?: null | () => void): Promise<TResult>

Parametrar

onfinally

null | () => void

Återanropet som ska köras när Promise har avgjorts (uppfyllt eller avvisat).

Returer

Promise<TResult>

Ett löfte om att återanropet ska slutföras.

ärvd från Promise.finally

then<TResult1, TResult2>(null | (value: TResult) => TResult1 | PromiseLike<TResult1>, null | (reason: any) => TResult2 | PromiseLike<TResult2>)

Bifogar återanrop för lösning och/eller avvisande av löftet.

function then<TResult1, TResult2>(onfulfilled?: null | (value: TResult) => TResult1 | PromiseLike<TResult1>, onrejected?: null | (reason: any) => TResult2 | PromiseLike<TResult2>): Promise<TResult1 | TResult2>

Parametrar

onfulfilled

null | (value: TResult) => TResult1 | PromiseLike<TResult1>

Återanropet som ska köras när Promise har lösts.

onrejected

null | (reason: any) => TResult2 | PromiseLike<TResult2>

Återanropet som ska köras när Promise avvisas.

Returer

Promise<TResult1 | TResult2>

Ett löfte för slutförandet av vilket återanrop någonsin körs.

ärvd från Promise.then