From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../readablestreamdefaultreader/cancel/index.html | 100 +++++++++++++++++++++ 1 file changed, 100 insertions(+) create mode 100644 files/ja/web/api/readablestreamdefaultreader/cancel/index.html (limited to 'files/ja/web/api/readablestreamdefaultreader/cancel') diff --git a/files/ja/web/api/readablestreamdefaultreader/cancel/index.html b/files/ja/web/api/readablestreamdefaultreader/cancel/index.html new file mode 100644 index 0000000000..ddf716d547 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultreader/cancel/index.html @@ -0,0 +1,100 @@ +--- +title: ReadableStreamDefaultReader.cancel() +slug: Web/API/ReadableStreamDefaultReader/cancel +tags: + - API + - Method + - ReadableStreamDefaultReader + - Reference + - Streams + - cancel +translation_of: Web/API/ReadableStreamDefaultReader/cancel +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultReader")}} インターフェイスの cancel() メソッドはストリームをキャンセルし、コンシューマーがストリームに興味を失ったことを通知します。 提供された reason 引数は、基になるソースに与えられ、使用する場合もしない場合もあります。

+ +

キャンセルは、ストリームを完全に終了し、読み取り待ちのチャンクがキューに入っている場合でも、それ以上データを必要としない場合に使用します。 キャンセルが呼び出された後、そのデータは失われ、ストリームは読み取り不能になります。 これらのチャンクをまだ読み取り、ストリームを完全に取り除くわけではない場合は、{{domxref("ReadableStreamDefaultController.close()")}} を使用します。

+ +
注: リーダーがアクティブな場合、cancel() メソッドは、関連付けられたストリームの場合（{{domxref("ReadableStream.cancel()")}}）と同じように振る舞います。
+ +

構文

+ +
var promise = readableStreamDefaultReader.cancel(reason);
+ +

パラメーター

+ +
+
reason {{optional_inline}}
+
人間が読むことができるキャンセルの理由を提供する {{domxref("DOMString")}}。
+
+ +

戻り値

+ +

{{jsxref("Promise")}}。 reason パラメーターで指定された値で満たされます。

+ +

Exceptions

+ +
+
TypeError
+
ソースオブジェクトが ReadableStreamDefaultReader ではないか、ストリームに所有者がいません。
+
+ +

例

+ +

次の簡単な例では、getReader() を使用して作成した {{domxref("ReadableStreamDefaultReader")}} を使用して、以前に作成したカスタムの ReadableStream を読み取ります（このコードは、単純なランダムストリームの例に基づいています）。 各チャンクを順番に読み取り、ストリームの読み取りが完了するまで UI に出力します。 ストリームの読み取りが完了すると、再帰関数から戻り、ストリーム全体を UI の別の部分に出力します。

+ +

ストリームが完了したら（if (done)）、reader.cancel() を実行してストリームをキャンセルし、それ以上使用する必要がないことを通知します。

+ +
function fetchStream() {
+  const reader = stream.getReader();
+  let charsReceived = 0;
+
+  // read() は、値を受け取ったときに解決する promise を返します
+  reader.read().then(function processText({ done, value }) {
+    // 結果オブジェクトには2つのプロパティが含まれます
+    // done  - ストリームがすべてのデータを既に提供している場合は true
+    // value - 一部のデータ。 done が true の場合、常に undefined
+    if (done) {
+      console.log("Stream complete");
+      reader.cancel();
+      para.textContent = result;
+      return;
+    }
+
+    // フェッチしたストリームの値は Uint8Array です
+    charsReceived += value.length;
+    const chunk = value;
+    let listItem = document.createElement('li');
+    listItem.textContent = 'Received ' + charsReceived + ' characters so far. Current chunk = ' + chunk;
+    list2.appendChild(listItem);
+
+    result += chunk;
+
+    // さらに読み、この関数を再度呼び出します
+    return reader.read().then(processText);
+  });
+}
+ +

仕様

+ + + + + + + + + + + + + + +
仕様状態コメント
{{SpecName("Streams","#default-reader-cancel","cancel()")}}{{Spec2('Streams')}}初期定義
+ +

ブラウザーの互換性

+ + + +

{{Compat("api.ReadableStreamDefaultReader.cancel")}}

-- cgit v1.2.3-54-g00ecf