Azure Core LRO ügyféloldali kódtár JavaScripthez – 3.3.1-es verzió

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. Ez a kódtár elsősorban AutoRest és autorest.typescriptáltal létrehozott kódban használható.

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

Főbb hivatkozások:

• forráskód
• Csomag (npm)
• API referenciadokumentációja
• Minták

Kezdő lépések

Jelenleg támogatott környezetek

• A Node.js LTS-verziói
• A Safari, a Chrome, az Edge és a Firefox legújabb verziói.

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

SimplePollerLike

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. A következő módszereket biztosítja:

• getOperationState: a művelet állapotát adja vissza, amely kiterjesztő típusként van begépelve OperationState
• getResult: a művelet eredményét adja vissza, amikor befejeződik, és undefined ellenkező esetben
• isDone: azt adja vissza, hogy a művelet terminálállapotban van-e
• isStopped: azt adja vissza, hogy a lekérdezés leállt-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
• stopPolling: leállítja a lekérdezést;
• toString: szerializálja a poller állapotát

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

createHttpPoller

Egy függvény, amely egy típusú SimplePollerLikeobjektumot 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.getOperationState().status igaz értékre lesz állítva, ha a művelet meghiúsul, 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: npm run unit-test.

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.