From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../close/index.html | 97 +++++++++++++++++++ .../desiredsize/index.html | 52 ++++++++++ .../enqueue/index.html | 98 +++++++++++++++++++ .../error/index.html | 68 +++++++++++++ .../api/readablestreamdefaultcontroller/index.html | 102 ++++++++++++++++++++ .../readablestreamdefaultcontroller/index.html | 107 +++++++++++++++++++++ 6 files changed, 524 insertions(+) create mode 100644 files/ja/web/api/readablestreamdefaultcontroller/close/index.html create mode 100644 files/ja/web/api/readablestreamdefaultcontroller/desiredsize/index.html create mode 100644 files/ja/web/api/readablestreamdefaultcontroller/enqueue/index.html create mode 100644 files/ja/web/api/readablestreamdefaultcontroller/error/index.html create mode 100644 files/ja/web/api/readablestreamdefaultcontroller/index.html create mode 100644 files/ja/web/api/readablestreamdefaultcontroller/readablestreamdefaultcontroller/index.html (limited to 'files/ja/web/api/readablestreamdefaultcontroller') diff --git a/files/ja/web/api/readablestreamdefaultcontroller/close/index.html b/files/ja/web/api/readablestreamdefaultcontroller/close/index.html new file mode 100644 index 0000000000..d9f299f563 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultcontroller/close/index.html @@ -0,0 +1,97 @@ +--- +title: ReadableStreamDefaultController.close() +slug: Web/API/ReadableStreamDefaultController/close +tags: + - API + - Method + - ReadableStreamDefaultController + - Reference + - Streams + - close +translation_of: Web/API/ReadableStreamDefaultController/close +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultController")}} インターフェイスの close() メソッドは、関連するストリームを閉じます。

+ +
+

リーダーは、以前にキューに入れられたチャンクをストリームから読み取ることができますが、それらを読み取とってしまうとストリームは閉じられます。 ストリームを完全に取り除き、キューに入れられたチャンクを破棄する場合は、{{domxref("ReadableStream.cancel()")}} または {{domxref("ReadableStreamDefaultReader.cancel()")}} を使用します。

+
+ +

構文

+ +
readableStreamDefaultController.close();
+ +

パラメーター

+ +

なし。

+ +

戻り値

+ +

undefined。

+ +

例外

+ +
+
TypeError
+
ソースオブジェクトは ReadableStreamDefaultController ではありません。
+
+ +

例

+ +

次の単純な例では、コンストラクターを使用してカスタムの ReadableStream を作成します（完全なコードについては、単純なランダムストリームの例を参照）。 start() 関数は、1秒ごとにテキストのランダムな文字列を生成し、それをストリームのキューに入れます。 {{domxref("ReadableStream.cancel()")}} が何らかの理由で呼び出された場合、生成を停止するための cancel() 関数も提供します。

+ +

ボタンが押されると、生成を停止し、{{domxref("ReadableStreamDefaultController.close()")}} を使用してストリームを閉じ、ストリームからデータを読み取る別の関数を実行します。

+ +
const stream = new ReadableStream({
+  start(controller) {
+    interval = setInterval(() => {
+      let string = randomChars();
+
+      // ストリームに文字列を追加
+      controller.enqueue(string);
+
+      // それを画面に表示
+      let listItem = document.createElement('li');
+      listItem.textContent = string;
+      list1.appendChild(listItem);
+    }, 1000);
+
+    button.addEventListener('click', function() {
+      clearInterval(interval);
+      fetchStream();
+      controller.close();
+    })
+  },
+  pull(controller) {
+    // この例では実際には pull は必要ありません
+  },
+  cancel() {
+    // リーダーがキャンセルされた場合に呼び出されるため、
+    // 文字列の生成を停止する必要があります
+    clearInterval(interval);
+  }
+});
+ +

仕様

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

ブラウザーの互換性

+ + + +

{{Compat("api.ReadableStreamDefaultController.close")}}

diff --git a/files/ja/web/api/readablestreamdefaultcontroller/desiredsize/index.html b/files/ja/web/api/readablestreamdefaultcontroller/desiredsize/index.html new file mode 100644 index 0000000000..4b2df43b36 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultcontroller/desiredsize/index.html @@ -0,0 +1,52 @@ +--- +title: ReadableStreamDefaultController.desiredSize +slug: Web/API/ReadableStreamDefaultController/desiredSize +tags: + - API + - Property + - ReadableStreamDefaultController + - Reference + - Streams + - desiredSize +translation_of: Web/API/ReadableStreamDefaultController/desiredSize +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultController")}} インターフェイスの desiredSize 読み取り専用プロパティは、ストリームの内部キューを満たすために必要な希望サイズを返します。

+ +

構文

+ +
var desiredSize = readableStreamDefaultController.desiredSize;
+ +

値

+ +

整数。 キューがいっぱいになった場合、これは負になる可能性があることに注意してください。

+ +

例

+ +

仕様にある基になるプッシュソースとバックプレッシャーサポートのある読み取り可能なストリームの例は、desiredSize を使用してストリームがいっぱいになったことを手動で検出し、バックプレッシャーを適用する良い例を示しています。 また、{{domxref("ReadablestreamDefaultController.error()")}} を使用して、依存しているシステムの別の部分に障害が発生した場合に手動でストリームのエラーをトリガーします。

+ +

仕様

+ + + + + + + + + + + + + + +
仕様状態コメント
{{SpecName("Streams","#rs-default-controller-desired-size","desiredSize")}}{{Spec2('Streams')}}初期定義
+ +

ブラウザーの互換性

+ + + +

{{Compat("api.ReadableStreamDefaultController.desiredSize")}}

diff --git a/files/ja/web/api/readablestreamdefaultcontroller/enqueue/index.html b/files/ja/web/api/readablestreamdefaultcontroller/enqueue/index.html new file mode 100644 index 0000000000..6a32192c41 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultcontroller/enqueue/index.html @@ -0,0 +1,98 @@ +--- +title: ReadableStreamDefaultController.enqueue() +slug: Web/API/ReadableStreamDefaultController/enqueue +tags: + - API + - Method + - ReadableStreamDefaultController + - Reference + - Streams + - enqueue +translation_of: Web/API/ReadableStreamDefaultController/enqueue +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultController")}} インターフェイスの enqueue() メソッドは、所与のチャンクを関連するストリームのキューに入れます。

+ +

構文

+ +
readableStreamDefaultController.enqueue(chunk);
+ +

パラメーター

+ +
+
chunk
+
キューに入れるチャンク。
+
+ +

戻り値

+ +

undefined。

+ +

例外

+ +
+
TypeError
+
ソースオブジェクトは ReadableStreamDefaultController ではありません。
+
+ +

例

+ +

次の単純な例では、コンストラクターを使用してカスタムの ReadableStream を作成します（完全なコードについては、単純なランダムストリームの例を参照）。 start() 関数は、1秒ごとにテキストのランダムな文字列を生成し、それをストリームのキューに入れます — controller.enqueue(string) を参照。 {{domxref("ReadableStream.cancel()")}} が何らかの理由で呼び出された場合、生成を停止するための cancel() 関数も提供します。

+ +

ボタンが押されると、生成を停止し、{{domxref("ReadableStreamDefaultController.close()")}} を使用してストリームを閉じ、ストリームからデータを読み取る別の関数を実行します。

+ +
const stream = new ReadableStream({
+  start(controller) {
+    interval = setInterval(() => {
+      let string = randomChars();
+
+      // ストリームに文字列を追加
+      controller.enqueue(string);
+
+      // それを画面に表示
+      let listItem = document.createElement('li');
+      listItem.textContent = string;
+      list1.appendChild(listItem);
+    }, 1000);
+
+    button.addEventListener('click', function() {
+      clearInterval(interval);
+      fetchStream();
+      controller.close();
+    })
+  },
+  pull(controller) {
+    // この例では実際には pull は必要ありません
+  },
+  cancel() {
+    // リーダーがキャンセルされた場合に呼び出されるため、
+    // 文字列の生成を停止する必要があります
+    clearInterval(interval);
+  }
+});
+ +

仕様

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

ブラウザーの互換性

+ + + +

{{Compat("api.ReadableStreamDefaultController.enqueue")}}

diff --git a/files/ja/web/api/readablestreamdefaultcontroller/error/index.html b/files/ja/web/api/readablestreamdefaultcontroller/error/index.html new file mode 100644 index 0000000000..bc787754f5 --- /dev/null +++ b/files/ja/web/api/readablestreamdefaultcontroller/error/index.html @@ -0,0 +1,68 @@ +--- +title: ReadableStreamDefaultController.error() +slug: Web/API/ReadableStreamDefaultController/error +tags: + - API + - Error + - Method + - ReadableStreamDefaultController + - Reference + - Streams +translation_of: Web/API/ReadableStreamDefaultController/error +--- +
{{APIRef("Streams")}}
+ +

{{domxref("ReadableStreamDefaultController")}} インターフェイスの error() メソッドにより、関連するストリームとの今後のやり取りがエラーになります。

+ +
+

注: error() メソッドは複数回呼び出すことができ、ストリームが読み取り可能でないときに呼び出すことができます。

+
+ +

構文

+ +
readableStreamDefaultController.error(e);
+ +

パラメーター

+ +
+
e
+
今後のやり取りを失敗させるエラー。
+
+ +

戻り値

+ +

undefined。

+ +

例外

+ +
+
TypeError
+
ソースオブジェクトが ReadableStreamDefaultController ではないか、何らかの理由でストリームが読み取り可能ではありません。
+
+ +

例

+ +

仕様にある基になるプッシュソースとバックプレッシャーサポートのある読み取り可能なストリームの例は、{{domxref("ReadablestreamDefaultController.desiredSize")}} を使用してストリームがいっぱいになったことを手動で検出し、バックプレッシャーを適用しています。 また、error() を使用して、依存しているシステムの別の部分に障害が発生した場合に手動でストリームのエラーをトリガーする良い例を示しています。

+ +

仕様

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

ブラウザーの互換性

+ + + +

{{Compat("api.ReadableStreamDefaultController.error")}}

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

{{APIRef("Streams")}}

+ +

Streams API の ReadableStreamDefaultController インターフェイスは、{{domxref("ReadableStream")}} の状態と内部キューを制御できるコントローラーを表します。 デフォルトのコントローラーは、バイトストリームではないストリーム用です。

+ +

コンストラクター

+ +
+
なし。 ReadableStreamDefaultController インスタンスは、ReadableStream の構築中に自動的に作成されます。
+
+ +

プロパティ

+ +
+
{{domxref("ReadableStreamDefaultController.desiredSize")}} {{readonlyInline}}
+
ストリームの内部キューを満たすために必要な希望サイズを返します。
+
+ +

メソッド

+ +
+
{{domxref("ReadableStreamDefaultController.close()")}}
+
関連するストリームを閉じます。
+
{{domxref("ReadableStreamDefaultController.enqueue()")}}
+
所与のチャンクを関連するストリームのキューに入れます。
+
{{domxref("ReadableStreamDefaultController.error()")}}
+
関連するストリームとの今後のやり取りでエラーを発生させます。
+
+ +

例

+ +

次の単純な例では、コンストラクターを使用してカスタムの ReadableStream を作成します（完全なコードについては、単純なランダムストリームの例を参照）。 start() 関数は、1秒ごとにテキストのランダムな文字列を生成し、それをストリームのキューに入れます。 {{domxref("ReadableStream.cancel()")}} が何らかの理由で呼び出された場合、生成を停止するための cancel() 関数も提供します。

+ +

{{domxref("ReadableStreamDefaultController")}} オブジェクトは、start() 関数および pull() 関数のパラメーターとして提供されることに注意してください。

+ +

ボタンが押されると、生成を停止し、{{domxref("ReadableStreamDefaultController.close()")}} を使用してストリームを閉じ、ストリームからデータを読み取る別の関数を実行します。

+ +
const stream = new ReadableStream({
+  start(controller) {
+    interval = setInterval(() => {
+      let string = randomChars();
+
+      // ストリームに文字列を追加
+      controller.enqueue(string);
+
+      // それを画面に表示
+      let listItem = document.createElement('li');
+      listItem.textContent = string;
+      list1.appendChild(listItem);
+    }, 1000);
+
+    button.addEventListener('click', function() {
+      clearInterval(interval);
+      fetchStream();
+      controller.close();
+    })
+  },
+  pull(controller) {
+    // この例では実際には pull は必要ありません
+  },
+  cancel() {
+    // リーダーがキャンセルされた場合に呼び出されるため、
+    // 文字列の生成を停止する必要があります
+    clearInterval(interval);
+  }
+});
+ +

仕様

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

ブラウザーの互換性

+ +
+ + +

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

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

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

+ +
+

注: このコンストラクターを手動で使用することはありません — これは、{{domxref("ReadableStream")}} オブジェクトの構築中に使用されます。

+
+ +

構文

+ +
var readableStreamDefaultController = new ReadableStreamDefaultController(stream, underlyingSource, size, highWaterMark);
+ +

パラメーター

+ +
+
stream
+
制御される {{domxref("ReadableStream")}}。
+
underlyingSource
+
構築されたストリームインスタンスの動作を定義するメソッドとプロパティを含むオブジェクト。 詳細については、ReadableStream() コンストラクターのパラメーター定義を参照してください。
+
size
+
 パラメーター chunk を含むメソッド — これは、各チャンクに使用するサイズをバイト単位で示します。
+
highWaterMark
+
負でない整数 — これは、バックプレッシャーが適用される前に内部キューに含めることができるチャンクの総数を定義します。
+
+ +

戻り値

+ +

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

+ +

例外

+ +
+
TypeError
+
指定された stream パラメーターは {{domxref("ReadableStream")}} ではないか、既にコントローラーが関連付けられています。
+
+ +

例

+ +

次の単純な例では、コンストラクターを使用してカスタムの ReadableStream を作成します（完全なコードについては、単純なランダムストリームの例を参照）。 start() 関数は、1秒ごとにテキストのランダムな文字列を生成し、それをストリームのキューに入れます。 {{domxref("ReadableStream.cancel()")}} が何らかの理由で呼び出された場合、生成を停止するための cancel() 関数も提供します。

+ +

{{domxref("ReadableStreamDefaultController")}} オブジェクトは、start() 関数および pull() 関数のパラメーターとして提供されることに注意してください。

+ +

ボタンが押されると、生成を停止し、{{domxref("ReadableStreamDefaultController.close()")}} を使用してストリームを閉じ、ストリームからデータを読み取る別の関数を実行します。

+ +
const stream = new ReadableStream({
+  start(controller) {
+    interval = setInterval(() => {
+      let string = randomChars();
+
+      // ストリームに文字列を追加
+      controller.enqueue(string);
+
+      // それを画面に表示
+      let listItem = document.createElement('li');
+      listItem.textContent = string;
+      list1.appendChild(listItem);
+    }, 1000);
+
+    button.addEventListener('click', function() {
+      clearInterval(interval);
+      fetchStream();
+      controller.close();
+    })
+  },
+  pull(controller) {
+    // この例では実際には pull は必要ありません
+  },
+  cancel() {
+    // リーダーがキャンセルされた場合に呼び出されるため、
+    // 文字列の生成を停止する必要があります
+    clearInterval(interval);
+  }
+});
+ +

仕様

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

ブラウザーの互換性

+ + + +

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

-- cgit v1.2.3-54-g00ecf