Azure Core LRO client library for JavaScript - version 3.4.0

Bu, hem tarayıcıda hem de NodeJS'de çalışan Azure SDK JavaScript istemci kitaplıklarında uzun süre çalışan işlemlerin varsayılan uygulamasıdır. Bu kütüphane, öncelikle TypeSpec@azure-tools/typespec-ts yayıcısı tarafından oluşturulan kodlarda kullanılmak üzere tasarlanmıştır.

@azure/core-lro Uzun Süre Çalışan İşlemler için Azure SDK Tasarım Yönergeleri'ni izler

Önemli bağlantılar:

İlk Adımlar

Şu anda desteklenen ortamlar

Kurulum

Bu paket öncelikli olarak oluşturulan kodda kullanılır ve doğrudan son kullanıcılar tarafından kullanılması amaçlanmamıştır.

Temel kavramlar

PollerLike

Poller, sunucuda uzun süre çalışan işlemi terminal durumuna ulaşana kadar durumu için yoklayan bir nesnedir. Ayrıca uzatılır Promise<TResult>, böylece doğrudan nihai sonucu elde edebilirsiniz await . Aşağıdakileri sağlar:

  • operationState: işlemin mevcut durumunu döndüren bir özellik, genişleten bir tür OperationStateolarak yazılır. Eğer anket yapan henüz gönderilmediyse geçerlidir undefined .
  • result: işlemin tamamlandığı anda sonucu döndüren bir özellik ve undefined aksi takdirde
  • isDone: işlemin terminal durumda olup olmadığını döndüren bir özellik
  • onProgress: Yoklama yanıtı her alındığında çağrılacak geri çağırma işlevlerini kaydeder
  • poll: tek bir yoklama isteği gönderir
  • pollUntilDone: işlemin sonucuyla çözülecek bir söz döndürür
  • serialize: bir vaat döndürür ve bu vaat anketçinin durumunun serileştirilmiş bir temsiline çözüm verir
  • submitted: Bir vaat döndürür ve bu vaat anketçi başarılı bir şekilde gönderildiğinde çözülür

OperationState

İşlem durumu için bir tür. Aşağıdaki olası değerleri içeren bir status alan içerir: notStarted, running, succeeded, failedve canceled. Aşağıdaki gibi erişilebilir:

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

türünde PollerLikebir nesne döndüren bir işlev. Bu poller, hataların varlığında aşağıdaki gibi davranır:

  • poll çağrısı yapılır ve pollUntilDone seçeneği true olarak ayarlanmadığı sürece resolveOnUnsuccessful işlemin başarısız olması veya iptal olması durumunda bir hata oluşturur.
  • poller.operationState?.status "failed" "canceled" işlem başarısız olduğunda veya hata yanıtı döndürdüğünde veya hataya dönüştüğünde ayarlanır.

Örnekler

Örnekler samples klasöründe bulunabilir.

Sorun giderme

Ağaç kesimi

Günlükler, Uzun Süre Çalışan İşlem poller'ını uygulayan kitaplığın takdirine bağlı olarak eklenebilir. azure-sdk-for-js içindeki paketler @azure/günlükçü kullanır.

Sonraki adımlar

Bu kitaplığın nasıl kullanılacağına ilişkin ayrıntılı örnekler için lütfen örnekleri dizinine göz atın.

Katkıda Bulunmak

Bu kitaplığa katkıda bulunmak istiyorsanız kodu oluşturma ve test etme hakkında daha fazla bilgi edinmek için lütfen katkıda bulunma kılavuzu okuyun.

Test Yapma

Testlerimizi çalıştırmak için önce bağımlılıkları kurun ( ile pnpm install), ardından birim testlerini şununla çalıştırın: pnpm run test:node.

Kullanım Kuralları

Bu proje, Microsoft Açık Kaynak Kullanım Kurallarıbenimsemiştir. Daha fazla bilgi için bkz. Davranış Kuralları SSS veya ek sorularınız veya yorumlarınızla opencode@microsoft.com iletişime geçin.

  • Last updated on