Klientská knihovna Azure Core LRO pro JavaScript – verze 3.3.1

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

@azure/core-lroDodržuje pokyny pro návrh sady Azure SDK pro dlouhotrvající operace.

Klíčové odkazy:

• Zdrojový kód
• Balíček (npm)
• Referenční dokumentace k rozhraní API
• Ukázky

Začínáme

Aktuálně podporovaná prostředí

• LTS verze Node.js
• Nejnovější verze Safari, Chrome, Edge a Firefox.

Instalace

Tento balíček se primárně používá ve vygenerovaném kódu a nemá být využíván přímo koncovými uživateli.

Klíčové koncepty

SimplePollerLike

Poller je objekt, který může dotazovat dlouho běžící operaci na serveru o jeho stavu, dokud nedosáhne stavu terminálu. Poskytuje následující metody:

• getOperationState: vrátí stav operace, který se zadává 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í, zda je operace v terminálovém stavu.
• isStopped: vrátí, jestli se dotazování zastavilo.
• onProgress: zaregistruje funkce zpětného volání, které se mají volat při každém přijetí odpovědi 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. Lze k němu přistupovat následujícím způsobem:

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

Funkce, která vrací objekt typu SimplePollerLike. Tento poller se chová následujícím způsobem v přítomnosti chyb:

• volání a pollpollUntilDone vyvolá chybu v případě, že operace selhala nebo byla zrušena, pokud nebyla resolveOnUnsuccessful 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 složce samples.

Řešení problémů

Logování

Protokoly lze přidat podle vlastního uvážení knihovny, která implementuje dlouhotrvající operaci vrtu. Balíčky uvnitř azure-sdk-for-js používají @azure/logger.

Další kroky

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

Přispění

Pokud chcete přispívat do této knihovny, přečtěte si průvodce přispívání a přečtěte si další informace o vytváření a testování kódu.

Testování

Chcete-li spustit naše testy, nejprve nainstalujte závislosti (s pnpm install) a poté spusťte testy jednotek pomocí: npm run unit-test.

Pravidla chování

Tento projekt přijal Kodex chování pro open source od Microsoftu. Další informace najdete v nejčastějších dotazech k kodexu chování nebo kontaktujte opencode@microsoft.com s dalšími dotazy nebo komentáři.