Pustaka klien Azure Abort Controller untuk JavaScript - versi 2.2.0

Paket ini @azure/abort-controller menyediakan AbortSignalLike antarmuka dan AbortError kelas untuk memudahkan bekerja dengan AbortController dan AbortSignal digunakan oleh fetch yang dibangun ke dalam platform JavaScript modern.

Pelanggan Azure SDK untuk JavaScript secara umum tidak perlu menggunakan pustaka ini. Sebagai gantinya, mereka menggunakan AbortController dan AbortSignal disediakan oleh platform mereka dan meneruskan sinyal pembatalan ke operasi Azure SDK.

Tautan kunci:

• Kode sumber
• Paket (npm)
• Dokumentasi Referensi API

Memulai Langkah Pertama

Installation

Instal library ini menggunakan npm sebagai berikut

npm install @azure/abort-controller

Konsep utama

Gunakan AbortController untuk membuat yang AbortSignal kemudian dapat diteruskan ke operasi Azure SDK untuk membatalkan pekerjaan yang tertunda. Dapat AbortSignal diakses melalui signal properti pada instance AbortController. An AbortSignal juga dapat dikembalikan langsung dari metode statis, misalnya AbortSignal.timeout(100). yang dibatalkan setelah 100 milidetik.

Examples

Contoh di bawah ini mengasumsikan bahwa itu doAsyncWork adalah fungsi yang mengambil sekantong properti, salah satunya adalah sinyal abort.

Contoh 1 - penggunaan dasar

async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  if (options.abortSignal.aborted) {
    return;
  }

  // do async work
}

const controller = new AbortController();
doAsyncWork({ abortSignal: controller.signal });

// at some point later
controller.abort();

Contoh 2 - Membatalkan dengan batas waktu

async function doAsyncWork(options: { abortSignal: AbortSignal }): Promise<void> {
  if (options.abortSignal.aborted) {
    return;
  }

  // do async work
}

const signal = AbortSignal.timeout(1000);
doAsyncWork({ abortSignal: signal });

Langkah berikutnya

Anda dapat membangun dan menjalankan pengujian secara lokal dengan menjalankan npm run test. Jelajahi folder test untuk melihat penggunaan dan perilaku tingkat lanjut kelas publik.

Troubleshooting

Jika Anda mengalami masalah saat menggunakan perpustakaan ini, jangan ragu untuk file masalah.

Contributing

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