Bagikan melalui

Pustaka klien Azure Core LRO untuk JavaScript - versi 2.7.2

  • Artikel

Ini adalah implementasi default dari operasi jangka panjang di pustaka klien JavaScript Azure SDK yang berfungsi di browser dan NodeJS. Pustaka ini terutama ditujukan untuk digunakan dalam kode yang dibuat oleh AutoRest dan autorest.typescript.

@azure/core-lro mengikuti Panduan Desain Azure SDK untuk Operasi yang Berjalan Lama

Tautan utama:

Memulai

Lingkungan yang didukung saat ini

Penginstalan

Paket ini terutama digunakan dalam kode yang dihasilkan dan tidak dimaksudkan untuk dikonsumsi secara langsung oleh pengguna akhir.

Konsep utama

SimplePollerLike

Poller adalah objek yang dapat melakukan polling operasi jangka panjang pada server untuk statusnya sampai mencapai status terminal. Ini menyediakan metode berikut:

  • getOperationState: mengembalikan status operasi, yang di ketik sebagai jenis yang diperluas OperationState
  • getResult: mengembalikan hasil operasi ketika selesai dan undefined sebaliknya
  • isDone: mengembalikan apakah operasi berada dalam status terminal
  • isStopped: mengembalikan apakah polling berhenti
  • onProgress: mendaftarkan fungsi panggilan balik yang akan dipanggil setiap kali respons polling diterima
  • poll: mengirimkan satu permintaan polling
  • pollUntilDone: mengembalikan janji yang akan diselesaikan dengan hasil operasi
  • stopPolling: menghentikan polling;
  • toString: menserialisasikan status poller

OperationState

Jenis untuk status operasi. Ini berisi status bidang dengan nilai yang mungkin berikut: notStarted, , runningsucceeded, failed, dan canceled. Ini dapat diakses sebagai berikut:

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

Fungsi yang mengembalikan objek jenis SimplePollerLike. Poller ini berakibat sebagai berikut jika terjadi kesalahan:

  • panggilan ke poll dan pollUntilDone akan melemparkan kesalahan jika operasi telah gagal atau dibatalkan kecuali resolveOnUnsuccessful opsi diatur ke true.
  • poller.getOperationState().status akan diatur ke true ketika operasi gagal atau mengembalikan respons kesalahan.

Contoh

Contoh dapat ditemukan di folder samples.

Pemecahan Masalah

Pencatatan

Log dapat ditambahkan atas kebijakan pustaka yang mengimplementasikan poller Operasi Jangka Panjang. Paket di dalam azure-sdk-for-js menggunakan @azure/pencatat.

Langkah berikutnya

Silakan lihat direktori sampel untuk contoh terperinci tentang cara menggunakan pustaka ini.

Berkontribusi

Jika Anda ingin berkontribusi pada pustaka ini, baca panduan berkontribusi untuk mempelajari selengkapnya tentang cara membuat dan menguji kode.

Pengujian

Untuk menjalankan pengujian kami, pertama-tama instal dependensi (dengan npm install atau rush install), lalu jalankan pengujian unit dengan: npm run unit-test.

Kode Etik

Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi selengkapnya, lihat Tanya Jawab Umum Tata Tertib atau hubungi opencode@microsoft.com untuk pertanyaan atau komentar lainnya.

Tayangan