JavaScript için Azure Core LRO istemci kitaplığı - sürüm 3.3.1

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 kitaplık öncelikli olarak AutoRest ve autorest.typescripttarafından oluşturulan kodda 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:

• Kaynak kodu
• Paket (npm)
• API Başvuru Belgeleri
• Örnekleri

İlk Adımlar

Şu anda desteklenen ortamlar

• Node.js LTS sürümleri
• Safari, Chrome, Edge ve Firefox'un en son sürümleri.

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

SimplePollerLike

Poller, sunucuda uzun süre çalışan işlemi terminal durumuna ulaşana kadar durumu için yoklayan bir nesnedir. Aşağıdaki yöntemleri sağlar:

• getOperationState: genişleten bir tür olarak yazılan işlemin durumunu döndürür OperationState
• getResult: tamamlandığında işlemin sonucunu döndürür ve undefined aksi halde
• isDone: işlemin terminal durumunda olup olmadığını döndürür
• isStopped: yoklamanın durdurulup durdurulmadığını döndürür
• 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
• stopPolling: yoklamayı durdurur;
• toString: Poller'ın durumunu serileştirir

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

createHttpPoller

türünde SimplePollerLikebir 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.getOperationState().status işlem başarısız olduğunda veya bir hata yanıtı döndürdüğünde true olarak 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: npm run unit-test.

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.