Klientská knihovna Azure Core LRO pro JavaScript – verze 2.7.2

  • Článek

Toto je výchozí implementace dlouhotrvajících operací v javascriptových klientských knihovnách sady Azure SDK, které fungují v prohlížeči i v NodeJS. Tato knihovna je primárně určena pro použití v kódu generovaném pomocí funkcí AutoRest a autorest.typescript.

@azure/core-lro v souladu s pokyny k návrhu sady Azure SDK pro dlouhotrvající operace

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

  • LtS verze Node.js
  • Nejnovější verze prohlížečů Safari, Chrome, Edge a Firefox.

Instalace

Tento balíček se primárně používá ve vygenerovaném kódu a není určen k přímému využití koncovými uživateli.

Klíčové koncepty

SimplePollerLike

Poller je objekt, který se může dotazovat dlouho běžící operace na serveru na svůj stav, dokud nedosáhne koncového stavu. Poskytuje následující metody:

  • getOperationState: vrátí stav operace napsaný jako typ, který rozšiřuje. OperationState
  • getResult: vrátí výsledek operace po dokončení a undefined v opačném případě
  • isDone: vrátí, jestli je operace v terminálovém stavu.
  • isStopped: vrátí, jestli se dotazování zastavilo.
  • onProgress: registruje funkce zpětného volání, které se mají volat při každém přijetí odpovědi na dotazování.
  • poll: odešle jednu žádost o dotazování.
  • pollUntilDone: vrátí příslib, který se vyřeší s výsledkem operace.
  • stopPolling: zastaví dotazování;
  • toString: serializuje stav poller

OperationState

Typ pro stav operace. Obsahuje status pole s následujícími možnými hodnotami: notStarted, running, succeeded, faileda canceled. Můžete k němu přistupovat následujícím způsobem:

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

Funkce, která vrací objekt typu SimplePollerLike. Tento poller se v případě chyb chová následovně:

  • poll volání a pollUntilDone vyvolá chybu v případě, že operace selhala nebo se zrušila, pokud resolveOnUnsuccessful nebyla možnost nastavena na hodnotu true.
  • poller.getOperationState().status pokud operace selže nebo vrátí chybovou odpověď, nastaví se na hodnotu true.

Příklady

Příklady najdete ve samples složce.

Poradce při potížích

protokolování

Protokoly je možné přidávat podle uvážení knihovny, která implementuje poller dlouhotrvající operace. Balíčky uvnitř azure-sdk-for-js používají @azure/logger.

Další kroky

Podrobné příklady použití této knihovny najdete v adresáři samples .

Přispívání

Pokud chcete přispívat do této knihovny, přečtěte si prosím průvodce přispívání , kde se dozvíte více o tom, jak sestavit a otestovat kód.

Testování

Pokud chcete spustit naše testy, nejprve nainstalujte závislosti (s npm install nebo rush install) a pak spusťte testy jednotek pomocí: npm run unit-test.

Pravidla chování

Tento projekt přijal pravidla chování pro Microsoft Open Source. Další informace najdete v nejčastějších dotazech k pravidlům chování nebo se obraťte na opencode@microsoft.com případné další dotazy nebo komentáře.

Imprese