Dela via

Azure Core LRO-klientbibliotek för JavaScript – version 2.7.2

  • Artikel

Det här är standardimplementeringen av långvariga åtgärder i Azure SDK JavaScript-klientbibliotek som fungerar i både webbläsaren och NodeJS. Det här biblioteket är främst avsett att användas i kod som genereras av AutoRest och autorest.typescript.

@azure/core-lro följer Designriktlinjerna för Azure SDK för tidskrävande åtgärder

Nyckellänkar:

Komma igång

Miljöer som stöds för närvarande

Installation

Det här paketet används främst i genererad kod och är inte avsett att användas direkt av slutanvändare.

Viktiga begrepp

SimplePollerLike

En poller är ett objekt som kan avsöka den långvariga åtgärden på servern för dess tillstånd tills den når ett terminaltillstånd. Den innehåller följande metoder:

  • getOperationState: returnerar tillståndet för åtgärden, skrivet som en typ som utökar OperationState
  • getResult: returnerar resultatet av åtgärden när den slutförs och undefined på annat sätt
  • isDone: returnerar om åtgärden är i ett terminaltillstånd
  • isStopped: returnerar om avsökningen stoppades
  • onProgress: registrerar återanropsfunktioner som ska anropas varje gång ett avsökningssvar tas emot
  • poll: skickar en enda avsökningsbegäran
  • pollUntilDone: returnerar ett löfte som kommer att lösas med resultatet av åtgärden
  • stopPolling: stoppar avsökningen;
  • toString: serialiserar pollerarens tillstånd

OperationState

En typ för åtgärdstillståndet. Det innehåller ett status fält med följande möjliga värden: notStarted, running, succeeded, failedoch canceled. Den kan nås på följande sätt:

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

En funktion som returnerar ett objekt av typen SimplePollerLike. Den här pollern beter sig så här i närvaro av fel:

  • anropar till poll och pollUntilDone genererar ett fel om åtgärden har misslyckats eller avbrutits om inte resolveOnUnsuccessful alternativet har angetts till sant.
  • poller.getOperationState().status anges till true när åtgärden misslyckas eller returnerar ett felsvar.

Exempel

Exempel finns i samples mappen .

Felsökning

Loggning

Loggar kan läggas till efter eget gottfinnande av biblioteket som implementerar polleraren för långvariga åtgärder. Paket i azure-sdk-for-js använder @azure/logger.

Nästa steg

Ta en titt på exempelkatalogen för detaljerade exempel på hur du använder det här biblioteket.

Bidra

Om du vill bidra till det här biblioteket kan du läsa bidragsguiden om du vill veta mer om hur du skapar och testar koden.

Testning

Om du vill köra våra tester installerar du först beroendena (med npm install eller ) och rush installkör sedan enhetstesterna med: npm run unit-test.

Regler för uppförande

Det här projektet använder sig av Microsofts uppförandekod för öppen källkod. Mer information finns i Vanliga frågor och svar om uppförandekoden eller kontakta opencode@microsoft.com med ytterligare frågor eller kommentarer.

Visningar