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 +++++++++++++++ .../readablestreamdefaultreader/closed/index.html | 54 ++++++++ .../web/api/readablestreamdefaultreader/index.html | 100 +++++++++++++++ .../readablestreamdefaultreader/read/index.html | 140 +++++++++++++++++++++ .../readablestreamdefaultreader/index.html | 96 ++++++++++++++ .../releaselock/index.html | 73 +++++++++++ 6 files changed, 563 insertions(+) create mode 100644 files/ja/web/api/readablestreamdefaultreader/cancel/index.html create mode 100644 files/ja/web/api/readablestreamdefaultreader/closed/index.html create mode 100644 files/ja/web/api/readablestreamdefaultreader/index.html create mode 100644 files/ja/web/api/readablestreamdefaultreader/read/index.html create mode 100644 files/ja/web/api/readablestreamdefaultreader/readablestreamdefaultreader/index.html create mode 100644 files/ja/web/api/readablestreamdefaultreader/releaselock/index.html (limited to 'files/ja/web/api/readablestreamdefaultreader') 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")}}

diff --git a/files/ja/web/api/readablestreamdefaultreader/closed/index.html b/files/ja/web/api/readablestreamdefaultreader/closed/index.html new file mode 100644 index 0000000000..62c55697bc --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultreader/closed/index.html @@ -0,0 +1,54 @@ +--- +title: ReadableStreamDefaultReader.closed +slug: Web/API/ReadableStreamDefaultReader/closed +tags: + - API + - Property + - ReadableStreamDefaultReader + - Reference + - Streams + - closed +translation_of: Web/API/ReadableStreamDefaultReader/closed +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultReader")}} インターフェイスの closed 読み取り専用プロパティは、ストリームが閉じられた場合、またはリーダーのロックが解除された場合に満たし、ストリームがエラーの場合に拒否する promise を返します。

+ +

構文

+ +
var closed = readableStreamDefaultReader.closed;
+ +

値

+ +

{{jsxref("Promise")}}。

+ +

例

+ +

このスニペットでは、以前に作成したリーダーに問い合わせて、ストリームが閉じられているかどうかを確認します。 閉じられると、promise が満たされ、メッセージをコンソールに記録します。

+ +
reader.closed.then(() => {
+  console.log('reader closed');
+})
+ +

仕様

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

ブラウザーの互換性

+ + + +

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

diff --git a/files/ja/web/api/readablestreamdefaultreader/index.html b/files/ja/web/api/readablestreamdefaultreader/index.html new file mode 100644 index 0000000000..9470ada513 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultreader/index.html @@ -0,0 +1,100 @@ +--- +title: ReadableStreamDefaultReader +slug: Web/API/ReadableStreamDefaultReader +tags: + - API + - Fetch + - Interface + - ReadableStreamDefaultReader + - Reference + - Streams +translation_of: Web/API/ReadableStreamDefaultReader +--- +

{{APIRef("Streams")}}

+ +

Streams API の ReadableStreamDefaultReader インターフェイスは、ネットワークから提供されたストリームデータ（フェッチ要求など）を読み取るために使用できるデフォルトのリーダーを表します。

+ +

コンストラクター

+ +
+
{{domxref("ReadableStreamDefaultReader.ReadableStreamDefaultReader", "ReadableStreamDefaultReader()")}}
+
ReadableStreamDefaultReader オブジェクトのインスタンスを作成して返します。
+
+ +

プロパティ

+ +
+
{{domxref("ReadableStreamDefaultReader.closed")}} {{readonlyInline}}
+
ストリーミングプロセスの終了に応答するコードを記述できます。 ストリームが閉じられた場合、またはリーダーのロックが解除された場合に満たされる promise を返します。 ストリームがエラーの場合は拒否します。
+
+ +

メソッド

+ +
+
{{domxref("ReadableStreamDefaultReader.cancel()")}}
+
ストリームをキャンセルし、コンシューマーがストリームに興味を失ったことを通知します。 提供された reason 引数は、基になるソースに与えられ、使用する場合もしない場合もあります。
+
{{domxref("ReadableStreamDefaultReader.read()")}}
+
ストリームの内部キュー内の次のチャンクへのアクセスを提供する promise を返します。
+
{{domxref("ReadableStreamDefaultReader.releaseLock()")}}
+
ストリームのリーダーのロックを解除します。
+
+ +

例

+ +

次の例では、別のリソースから取得した HTML の断片をブラウザーにストリーミングするために、人工的な {{domxref("Response")}} を作成します。

+ +

これは {{jsxref("Uint8Array")}} と組み合わせた {{domxref("ReadableStream")}} の使用方法を示します。

+ +
fetch("https://www.example.org/").then((response) => {
+  const reader = response.body.getReader();
+  const stream = new ReadableStream({
+    start(controller) {
+      // 次の関数は各データチャンクを処理します
+      function push() {
+        // done は Boolean で、value は Uint8Array です
+        return reader.read().then(({ done, value }) => {
+          // 読み取るデータはもうありませんか？
+          if (done) {
+            // データの送信が完了したことをブラウザーに伝えます
+            controller.close();
+            return;
+          }
+
+          // データを取得し、コントローラー経由でブラウザーに送信します
+          controller.enqueue(value);
+          push();
+        });
+      };
+
+      push();
+    }
+  });
+
+  return new Response(stream, { headers: { "Content-Type": "text/html" } });
+});
+
+ +

仕様

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

ブラウザーの互換性

+ +
+ + +

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

+
diff --git a/files/ja/web/api/readablestreamdefaultreader/read/index.html b/files/ja/web/api/readablestreamdefaultreader/read/index.html new file mode 100644 index 0000000000..e472709397 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultreader/read/index.html @@ -0,0 +1,140 @@ +--- +title: ReadableStreamDefaultReader.read() +slug: Web/API/ReadableStreamDefaultReader/read +tags: + - API + - Method + - ReadableStreamDefaultReader + - Reference + - Streams + - read +translation_of: Web/API/ReadableStreamDefaultReader/read +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultReader")}} インターフェイスの read() メソッドは、ストリームの内部キュー内の次のチャンクへのアクセスを提供する promise を返します。

+ +

構文

+ +
var promise = readableStreamDefaultReader.read();
+ +

パラメーター

+ +

なし。

+ +

戻り値

+ +

{{jsxref("Promise")}}。ストリームの状態に応じて結果を充足/拒否します。 異なる可能性は次のとおりです。

+ + + +

例外

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

例

+ +

例 1 - 簡単な例

+ +

この例は、基本的な API の使用方法を示していますが、例えば、行の境界で終了しないストリームチャンクなどの複雑な問題には対処しません。

+ +

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

+ +
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");
+      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);
+  });
+}
+ +

例 2 - テキストを1行ずつ処理する

+ +

この例は、テキストファイルをフェッチし、テキスト行のストリームとして処理する方法を示しています。 行の境界で終了せず、Uint8Array から文字列に変換するストリームチャンクを処理します。

+ +
async function* makeTextFileLineIterator(fileURL) {
+  const utf8Decoder = new TextDecoder("utf-8");
+  let response = await fetch(fileURL);
+  let reader = response.body.getReader();
+  let {value: chunk, done: readerDone} = await reader.read();
+  chunk = chunk ? utf8Decoder.decode(chunk) : "";
+
+  let re = /\n|\r|\r\n/gm;
+  let startIndex = 0;
+  let result;
+
+  for (;;) {
+    let result = re.exec(chunk);
+    if (!result) {
+      if (readerDone) {
+        break;
+      }
+      let remainder = chunk.substr(startIndex);
+      ({value: chunk, done: readerDone} = await reader.read());
+      chunk = remainder + (chunk ? utf8Decoder.decode(chunk) : "");
+      startIndex = re.lastIndex = 0;
+      continue;
+    }
+    yield chunk.substring(startIndex, result.index);
+    startIndex = re.lastIndex;
+  }
+  if (startIndex < chunk.length) {
+    // 最後の行は改行文字で終わっていません
+    yield chunk.substr(startIndex);
+  }
+}
+
+for await (let line of makeTextFileLineIterator(urlOfFile)) {
+  processLine(line);
+}
+ +

仕様

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

ブラウザーの互換性

+ + + +

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

diff --git a/files/ja/web/api/readablestreamdefaultreader/readablestreamdefaultreader/index.html b/files/ja/web/api/readablestreamdefaultreader/readablestreamdefaultreader/index.html new file mode 100644 index 0000000000..b7fa07fcda --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultreader/readablestreamdefaultreader/index.html @@ -0,0 +1,96 @@ +--- +title: ReadableStreamDefaultReader.ReadableStreamDefaultReader() +slug: Web/API/ReadableStreamDefaultReader/ReadableStreamDefaultReader +tags: + - API + - Constructor + - ReadableStreamDefaultReader + - Reference + - Streams +translation_of: Web/API/ReadableStreamDefaultReader/ReadableStreamDefaultReader +--- +
{{APIRef("Streams")}}
+ +

ReadableStreamDefaultReader() コンストラクターは、ReadableStreamDefaultReader オブジェクトのインスタンスを作成して返します。

+ +
+

注: 通常、このコンストラクターを手動で使用することはありません。 代わりに、{{domxref("ReadableStream.getReader()")}}) メソッドを使用します。

+
+ +

構文

+ +
var readableStreamDefaultReader = new ReadableStreamDefaultReader(stream);
+ +

パラメーター

+ +
+
stream
+
読み取られる {{domxref("ReadableStream")}}。
+
+ +

戻り値

+ +

{{domxref("ReadableStreamDefaultReader")}} オブジェクトのインスタンス。

+ +

例外

+ +
+
TypeError
+
指定された stream パラメーターは {{domxref("ReadableStream")}} ではないか、別のリーダーによる読み取りのために既にロックされています。
+
+ +

例

+ +

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

+ +
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");
+      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-constructor","ReadableStreamDefaultReader()")}}{{Spec2('Streams')}}初期定義
+ +

ブラウザーの互換性

+ + + +

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

diff --git a/files/ja/web/api/readablestreamdefaultreader/releaselock/index.html b/files/ja/web/api/readablestreamdefaultreader/releaselock/index.html new file mode 100644 index 0000000000..76ef5b5b03 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultreader/releaselock/index.html @@ -0,0 +1,73 @@ +--- +title: ReadableStreamDefaultReader.releaseLock() +slug: Web/API/ReadableStreamDefaultReader/releaseLock +tags: + - API + - Method + - ReadableStreamDefaultReader + - Reference + - Streams + - releaseLock +translation_of: Web/API/ReadableStreamDefaultReader/releaseLock +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultReader")}} インターフェイスの releaseLock() メソッドは、ストリームのリーダーのロックを解除します。

+ +

ロックを解除したときに関連するストリームにエラーが発生した場合、リーダーはその後同様にエラーが発生したようになります。 そうでない場合、リーダーは閉じた状態になります。

+ +

リーダーのロックは、保留中の読み取り要求が残っている間、つまり、リーダーの {{domxref("ReadableStreamDefaultReader.read()")}} メソッドによって返された promise が終了していない場合、解除できません。 これにより、TypeError がスローされます。

+ +

構文

+ +
readableStreamDefaultReader.releaseLock();
+ +

パラメーター

+ +

なし。

+ +

Return value

+ +

undefined。

+ +

例外

+ +
+
TypeError
+
ソースオブジェクトが ReadableStreamDefaultReader でないか、読み取り要求が保留中です。
+
+ +

例

+ +
function fetchStream() {
+  const reader = stream.getReader();
+
+  ...
+
+  reader.releaseLock()
+
+  ...
+}
+ +

仕様

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

ブラウザーの互換性

+ + + +

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

-- cgit v1.2.3-54-g00ecf