Megosztás a következőn keresztül:

Azure Core LRO-ügyfélkódtár JavaScripthez – 2.7.2-es verzió

  • Cikk

Ez a hosszú ideig futó műveletek alapértelmezett implementálása az Azure SDK JavaScript ügyfélkódtáraiban, amelyek a böngészőben és a NodeJS-ben is működnek. Ez a kódtár elsősorban az AutoRest és autorest.typescripta által létrehozott kódban használható.

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

Fő hivatkozások:

Első lépések

Jelenleg támogatott környezetek

Telepítés

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

Fő fogalmak

SimplePollerLike

A lekérdezések olyan objektumok, amelyek lekérdezhetik a kiszolgálón futó hosszú ideig futó műveletet az állapotuk alapján, amíg el nem éri a terminál állapotát. A következő módszereket biztosítja:

  • getOperationState: a művelet állapotát adja vissza, a típust meghosszabbító típusként begépelve OperationState
  • getResult: a művelet eredményét adja vissza, amikor befejeződik, és undefined egyéb módon
  • 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 érkezésekor meghívja őket
  • 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 mező a következő lehetséges értékekkel rendelkezik status : notStarted, running, succeeded, failed, és canceled. A következő módon érhető el:

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

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:

  • a és a pollpollUntilDone hívása hibát jelez, ha a művelet meghiúsult vagy megszakadt, kivéve, ha a resolveOnUnsuccessful beállítás igaz értékre van állítva.
  • poller.getOperationState().status akkor lesz igaz értékre állítva, ha a művelet meghiúsul, vagy hibaválaszt ad vissza.

Példák

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

Hibaelhárítás

Naplózás

A naplók a hosszú ideig futó művelet pollerét implementáló kódtár saját 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 mintakö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 vagy a használatávalnpm install), majd futtassa az egységteszteket a következővel: npm run unit-test.rush install

Viselkedési szabályzat

A projekt a Microsoft nyílt forráskódú projekteket szabályozó etikai kódexe, a Microsoft Open Source Code of Conduct hatálya alá esik. További információkért lásd a viselkedési szabályzattal kapcsolatos gyakori kérdéseket , vagy vegye fel a kapcsolatot opencode@microsoft.com az esetleges további kérdésekkel vagy megjegyzésekkel.

Megjelenések