Azure Core LRO client library for JavaScript - version 3.4.0

Ez a hosszú ideig futó műveletek alapértelmezett implementálása az Azure SDK JavaScript-ügyfélkódtárakban, amelyek a böngészőben és a NodeJS-ben is működnek. Ezt a könyvtárat elsősorban a TypeSpec@azure-tools/typespec-ts emitter által generált kódban való használatra szánták.

@azure/core-lro az Azure SDK hosszú futású műveletekre vonatkozó tervezési irányelveit követi

Főbb hivatkozások:

Kezdő lépések

Jelenleg támogatott környezetek

Telepítés

Ezt a csomagot elsősorban generált kódban használják, és nem közvetlenül a végfelhasználóknak szánták.

Főbb fogalmak

PollerLike

A lekérdezés olyan objektum, amely lekérdezi a kiszolgálón a hosszú ideig futó műveletet az állapotához, amíg el nem éri a terminálállapotot. Emellett meghosszabbítja Promise<TResult>, így await közvetlenül megteheted a végső eredményt. A következőket nyújtja:

  • operationState: egy tulajdonság, amely a művelet aktuális állapotát adja vissza, olyan típusként, amely kiterjeszti OperationState. Akkor igen undefined , ha a szavazót még nem nyújtották be.
  • result: egy tulajdonság, amely a művelet eredményét adja vissza, amikor az befejeződik, és undefined egyébként
  • isDone: egy tulajdonság, amely visszaadja a művelet terminális állapotban van-e
  • onProgress: regisztrálja a visszahívási függvényeket, hogy minden lekérdezési válasz érkezzen
  • poll: egyetlen lekérdezési kérést küld
  • pollUntilDone: a művelet eredményével feloldható ígéretet ad vissza
  • serialize: egy ígéretet ad, amely a poller állapotának sorozatos ábrázolására alakul
  • submitted: egy ígéretet ad, amely akkor oldódik, amikor a poller sikeresen beküldték

OperationState

A műveletállapot típusa. A következő lehetséges értékeket tartalmazó mezőt tartalmaz status : notStarted, running, succeeded, failedés canceled. A következő módon érhető el:

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

Egy függvény, amely egy típusú PollerLikeobjektumot ad vissza. Ez a lekérdezés a következő módon viselkedik a hibák jelenlétében:

  • hívásokat kezdeményez, poll és pollUntilDone hibát jelez, ha a művelet meghiúsult vagy megszakadt, kivéve, ha a resolveOnUnsuccessful beállítás értéke igaz.
  • poller.operationState?.status akkor lesz beállítva, "failed" vagy "canceled" amikor a művelet meghibásodik, vagy hibaválaszt ad vissza.

Példák

Példák a samples mappában találhatók.

Hibaelhárítás

Fakitermelés

A naplók a Long Running Operation pollert implementáló kódtár belátása szerint vehetők fel. Az Azure-sdk-for-js csomagjai@azure/loggert használnak.

Következő lépések

A kódtár használatára vonatkozó részletes példákért tekintse meg a mintákat könyvtárat.

Közreműködés

Ha hozzá szeretne járulni ehhez a kódtárhoz, olvassa el a közreműködői útmutatót, amelyből többet is megtudhat a kód összeállításáról és teszteléséről.

Tesztelés

A tesztek futtatásához először telepítse a függőségeket (a pnpm install) segítségével, majd futtassa az egységteszteket a következővel: pnpm run test:node.

Magatartási kódex

Ez a projekt elfogadta a Microsoft nyílt forráskódú magatartási kódexének . További információkért lásd a magatartási kódexével kapcsolatos gyakori kérdéseket, vagy további kérdésekkel vagy megjegyzésekkel forduljon opencode@microsoft.com.

  • Last updated on