Share via

@azure/core-lro package

  • Referentie

Klassen

LroEngine

De LRO-engine, een klasse die polling uitvoert.
Poller

Een klasse die de definitie vertegenwoordigt van een programma dat een poll uitvoert via opeenvolgende aanvragen totdat het een voltooiingsstatus heeft bereikt.

Een poller kan handmatig worden uitgevoerd door aanvraag per aanvraag te pollen door herhaaldelijk aan te roepen naar de methode, totdat de poll() bewerking is voltooid. Het biedt ook een manier om te wachten totdat de bewerking is voltooid, door aan te roepen pollUntilDone() en te wachten totdat de bewerking is voltooid. Pollers kunnen ook de annulering aanvragen van het lopende proces aan wie de onderliggende langlopende bewerking levert.

const poller = new MyPoller();

// Polling just once:
await poller.poll();

// We can try to cancel the request here, by calling:
//
//     await poller.cancelOperation();
//

// Getting the final result:
const result = await poller.pollUntilDone();

De poller wordt gedefinieerd door twee typen, een type dat de status van de poller vertegenwoordigt, die een basisset met eigenschappen van moet bevatten uit PollOperationState<TResult>en een retourtype dat is gedefinieerd door TResult, wat van alles kan zijn.

De Poller-klasse implementeert de PollerLike interface, waarmee poller-implementaties voorkomen dat de poller-klasse rechtstreeks moet worden geëxporteerd. In plaats daarvan exporteert u alleen de reeds geïnstantieerde poller met het type PollerLike.

class Client {
  public async makePoller: PollerLike<MyOperationState, MyResult> {
    const poller = new MyPoller({});
    // It might be preferred to return the poller after the first request is made,
    // so that some information can be obtained right away.
    await poller.poll();
    return poller;
  }
}

const poller: PollerLike<MyOperationState, MyResult> = myClient.makePoller();

Een poller kan worden gemaakt via de constructor, waarna deze kan worden gepolleerd totdat deze is voltooid. Op elk gewenst moment kan de status van de poller zonder vertraging worden verkregen via de getOperationState-methode. Op elk moment kunnen de tussenliggende vormen van het resultaattype zonder vertraging worden aangevraagd. Zodra de onderliggende bewerking is gemarkeerd als voltooid, stopt de poller en wordt de uiteindelijke waarde geretourneerd.

const poller = myClient.makePoller();
const state: MyOperationState = poller.getOperationState();

// The intermediate result can be obtained at any time.
const result: MyResult | undefined = poller.getResult();

// The final result can only be obtained after the poller finishes.
const result: MyResult = await poller.pollUntilDone();
PollerCancelledError

Wanneer de bewerking wordt geannuleerd, wordt de poller geweigerd met een exemplaar van de PollerCancelledError.
PollerStoppedError

Wanneer een poller handmatig wordt gestopt via de stopPolling methode, wordt de poller geweigerd met een exemplaar van de PollerStoppedError.

Interfaces

CreateHttpPollerOptions

Opties voor createPoller.
LongRunningOperation

Beschrijving van een langdurige bewerking.
LroEngineOptions

Opties voor de LRO-poller.
LroResponse

Het type antwoord van een LRO.
OperationState

Terwijl de poller werkt als het lokale controlemechanisme om te beginnen met activeren en wachten op een langdurige bewerking, documenteert OperationState de status van de externe langlopende bewerking. Deze wordt bijgewerkt na elke poll.
PollOperation

PollOperation is een interface die definieert hoe de lokale verwijzing van de status van de externe langlopende bewerking moet worden bijgewerkt, net zoals hoe u de annulering van dezelfde bewerking aanvraagt.

Het heeft ook een methode om de bewerking te serialiseren, zodat deze op elk gewenst moment kan worden opgeslagen en hervat.
PollOperationState

PollOperationState bevat een aangepaste lijst met de kleinste set eigenschappen die nodig zijn om een poller voor langdurige bewerkingen te definiëren.

Terwijl de Poller-klasse werkt als het lokale controlemechanisme om te beginnen met het activeren, wachten op en mogelijk annuleren van een langlopende bewerking, documenteert pollOperationState de status van de externe langlopende bewerking.

Deze moet ten minste worden bijgewerkt wanneer de bewerking wordt gestart, voltooid en geannuleerd. Implementaties kunnen echter een ander aantal eigenschappen hebben dat om andere redenen kan worden bijgewerkt.
PollerLike

Abstracte weergave van een poller, bedoeld om alleen de minimale API beschikbaar te maken waarmee de gebruiker moet werken.
RawResponse

Eenvoudig type van het onbewerkte antwoord.
SimplePollerLike

Een eenvoudige poller-interface.

Type-aliassen

CancelOnProgress

CancelOnProgress wordt gebruikt als de retourwaarde van de onProgress-methode van een Poller. Wanneer een gebruiker onProgress aanroept, moet deze een functie doorgeven die wordt aangeroepen als een callback met de nieuwe gegevens die worden ontvangen telkens wanneer de pollbewerking wordt bijgewerkt. onProgress retourneert een functie die verdere updates verhindert om de oorspronkelijke callback te bereiken.
LroResourceLocationConfig

De potentiële locatie van het resultaat van de LRO als opgegeven door de LRO-extensie in de swagger.
OperationStatus

De set mogelijke statussen waarin een bewerking zich op een bepaald moment kan bevinden.
PollProgressCallback

PollProgressCallback is het type callback-functies dat naar onProgress wordt verzonden. Deze functies ontvangen een TState die is gedefinieerd door uw implementatie van de Poller-klasse.

Functies

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Hiermee maakt u een poller die kan worden gebruikt om een langlopende bewerking te peilen.

Functiedetails

createHttpPoller<TResult, TState>(LongRunningOperation<unknown>, CreateHttpPollerOptions<TResult, TState>)

Hiermee maakt u een poller die kan worden gebruikt om een langlopende bewerking te peilen.

function createHttpPoller<TResult, TState>(lro: LongRunningOperation<unknown>, options?: CreateHttpPollerOptions<TResult, TState>): Promise<SimplePollerLike<TState, TResult>>

Parameters

lro

LongRunningOperation<unknown>

Beschrijving van de langdurige bewerking

options

CreateHttpPollerOptions<TResult, TState>

opties voor het configureren van de poller

Retouren

Promise<SimplePollerLike<TState, TResult>>

een geïnitialiseerde poller