Azure Core LRO-clientbibliotheek voor JavaScript - versie 3.3.1

Dit is de standaardimplementatie van langdurige 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 ontwerprichtlijnen voor de Azure SDK voor langdurige bewerkingen

Sleutelkoppelingen:

• Broncode
• package (npm)
• API-referentiedocumentatie
• Voorbeelden

Aan de slag

Momenteel ondersteunde omgevingen

• LTS-versies van Node.js
• Nieuwste versies van Safari, Chrome, Edge en Firefox.

Installatie

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

Belangrijke concepten

SimplePollerLike

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

• getOperationState: retourneert de status van de bewerking, getypt als een type dat 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: geeft als resultaat of de polling is gestopt
• onProgress: registreert callback-functies 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, en failedcanceled. Deze kan als volgt worden geopend:

switch (poller.operationState.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 in de aanwezigheid van fouten:

• aanroepen naar poll en pollUntilDone genereert 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 als er een foutreactie wordt geretourneerd.

Voorbeelden

Voorbeelden vindt u in de map samples.

Probleemoplossingsproces

Loggen

Logboeken kunnen naar eigen goeddunken worden toegevoegd aan de bibliotheek voor het implementeren van de poller voor langdurige bewerkingen. Pakketten in azure-sdk-for-js maken gebruik van @azure/logger.

Volgende stappen

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

Bijdragen

Als u een bijdrage wilt leveren aan deze bibliotheek, leest u de gids 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 pnpm install) en voert u vervolgens de eenheidstests uit met: npm run unit-test.

Gedragscode

Dit project heeft de Microsoft Open Source-gedragscodeaangenomen. Zie de Veelgestelde vragen over gedragscodes voor meer informatie of neem contact op met opencode@microsoft.com met eventuele aanvullende vragen of opmerkingen.