Azure Core LRO client library for JavaScript - version 3.4.0

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 emitorem TypeSpec@azure-tools/typespec-ts .

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

Klíčové odkazy:

Začínáme

Aktuálně podporovaná prostředí

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

PollerLike

Poller je objekt, který může dotazovat dlouho běžící operaci na serveru o jeho stavu, dokud nedosáhne stavu terminálu. Také rozšiřuje Promise<TResult>, takže můžete await použít přímo pro dosažení výsledku. Poskytuje následující:

  • operationState: vlastnost, která vrací aktuální stav operace, typovaná jako typ, který rozšiřuje OperationState. Je to v undefined případě, že průzkum ještě nebyl odeslán.
  • result: vlastnost, která vrací výsledek operace při jejím dokončení a undefined jinak
  • isDone: vlastnost, která vrací, zda je operace v terminálním stavu
  • 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.
  • serialize: vrací slib, který se rozuzlí do serializované reprezentace Pollerova stavu
  • submitted: vrací slib, který se vyřeší, když byl poller úspěšně odeslán

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.result;
  case "failed": // throw poller.operationState?.error;
  case "canceled": // throw new Error("Operation was canceled");
  case "running": // ...
  case "notStarted": // ...
}

createHttpPoller

Funkce, která vrací objekt typu PollerLike. 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.operationState?.status bude nastaveno na nebo "failed""canceled" když operace selže nebo vrátí chybovou odpověď.

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í: pnpm run test:node.

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.

  • Last updated on