Delen via

Azure Core LRO-clientbibliotheek voor JavaScript - versie 2.7.2

  • Artikel

Dit is de standaardimplementatie van langlopende bewerkingen in Azure SDK JavaScript-clientbibliotheken die werken in zowel de browser als NodeJS. Deze bibliotheek is voornamelijk bedoeld om te worden gebruikt in code die wordt gegenereerd door AutoRest en autorest.typescript.

@azure/core-lro volgt de Azure SDK-ontwerprichtlijnen voor langlopende bewerkingen

Belangrijke koppelingen:

Aan de slag

Momenteel ondersteunde omgevingen

Installatie

Dit pakket wordt voornamelijk gebruikt in gegenereerde code en is niet bedoeld om rechtstreeks door eindgebruikers te worden gebruikt.

Belangrijkste concepten

SimplePollerLike

Een poller is een object dat de langlopende bewerking op de server kan controleren op de status totdat deze een terminalstatus bereikt. Het biedt de volgende methoden:

  • getOperationState: retourneert de status van de bewerking, getypt als een type dat zich uitbreidt OperationState
  • getResult: retourneert het resultaat van de bewerking wanneer deze is voltooid en undefined anders
  • isDone: retourneert of de bewerking een terminalstatus heeft
  • isStopped: retourneert of de polling is gestopt
  • onProgress: registreert callbackfuncties die moeten worden aangeroepen telkens wanneer een polling-antwoord wordt ontvangen
  • poll: verzendt één polling-aanvraag
  • pollUntilDone: retourneert een belofte die wordt omgezet met het resultaat van de bewerking
  • stopPolling: stopt polling;
  • toString: serialiseert de status van de poller

OperationState

Een type voor de bewerkingsstatus. Het bevat een status veld met de volgende mogelijke waarden: notStarted, running, succeeded, faileden canceled. U kunt deze als volgt openen:

switch(poller.getOperationState().status) {
  case "succeeded":  // return poller.getResult();
  case "failed":     // throw poller.getOperationState().error;
  case "canceled":   // throw new Error("Operation was canceled");
  case "running":    // ...
  case "notStarted": // ...
}

createHttpPoller

Een functie die een object van het type SimplePollerLikeretourneert. Deze poller gedraagt zich als volgt wanneer er fouten optreden:

  • aanroepen naar poll en pollUntilDone genereren een fout als de bewerking is mislukt of geannuleerd, tenzij de resolveOnUnsuccessful optie is ingesteld op true.
  • poller.getOperationState().status wordt ingesteld op true wanneer de bewerking mislukt of een foutreactie retourneert.

Voorbeelden

Voorbeelden vindt u in de samples map.

Problemen oplossen

Logboekregistratie

Logboeken kunnen worden toegevoegd naar eigen goeddunken van de bibliotheek die de poller voor langlopende bewerkingen implementeert. Pakketten in azure-sdk-for-js gebruiken @azure/logger.

Volgende stappen

Bekijk de map met voorbeelden voor gedetailleerde voorbeelden van het gebruik van deze bibliotheek.

Bijdragen

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de handleiding voor bijdragen voor meer informatie over het bouwen en testen van de code.

Testen

Als u onze tests wilt uitvoeren, installeert u eerst de afhankelijkheden (met npm install of rush install) en voert u vervolgens de eenheidstests uit met: npm run unit-test.

Gedragscode

Op dit project is de Microsoft Open Source Code of Conduct (Microsoft Open Source-gedragscode) van toepassing. Zie voor meer informatie de veelgestelde vragen over de gedragscode of neem contact op opencode@microsoft.com met eventuele aanvullende vragen of opmerkingen.

Weergaven