diff options
author | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
---|---|---|
committer | Peter Bengtsson <mail@peterbe.com> | 2020-12-08 14:40:17 -0500 |
commit | 33058f2b292b3a581333bdfb21b8f671898c5060 (patch) | |
tree | 51c3e392513ec574331b2d3f85c394445ea803c6 /files/ja/web/api/readablestream/getreader/index.html | |
parent | 8b66d724f7caf0157093fb09cfec8fbd0c6ad50a (diff) | |
download | translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.gz translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.tar.bz2 translated-content-33058f2b292b3a581333bdfb21b8f671898c5060.zip |
initial commit
Diffstat (limited to 'files/ja/web/api/readablestream/getreader/index.html')
-rw-r--r-- | files/ja/web/api/readablestream/getreader/index.html | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/files/ja/web/api/readablestream/getreader/index.html b/files/ja/web/api/readablestream/getreader/index.html new file mode 100644 index 0000000000..d59680ecaf --- /dev/null +++ b/files/ja/web/api/readablestream/getreader/index.html @@ -0,0 +1,102 @@ +--- +title: ReadableStream.getReader() +slug: Web/API/ReadableStream/getReader +tags: + - API + - Method + - ReadableStream + - Reference + - Streams + - getReader +translation_of: Web/API/ReadableStream/getReader +--- +<div>{{APIRef("Streams")}}</div> + +<p class="summary"><span class="seoSummary">{{domxref("ReadableStream")}} インターフェイスの <strong><code>getReader()</code></strong> メソッドはリーダーを作成し、それでストリームをロックします。 ストリームがロックされている間は、このリーダーが開放されるまで他のリーダーを取得できません。</span></p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <em>reader</em> = <em>readableStream</em>.getReader(<em>{mode}</em>);</pre> + +<h3 id="Parameters" name="Parameters">パラメーター</h3> + +<dl> + <dt>{mode} {{optional_inline}}</dt> + <dd>プロパティ <code>mode</code> を含むオブジェクト。 <code>mode</code> は作成するリーダーのタイプを指定する {{domxref("DOMString")}} を値として受け取ります。 値は次のとおりです。 + <ul> + <li><code>"byob"</code>。 これにより、読み取り可能なバイトストリームを読み取ることができる {{domxref("ReadableStreamBYOBReader")}} が作成されます(つまり、「独自のバッファーを持ち込む」読み取りを処理できます)。</li> + <li><code>undefined</code>(またはまったく指定されていない — これがデフォルトです)。 これにより、ストリームから個々のチャンクを読み取ることができる {{domxref("ReadableStreamDefaultReader")}} が作成されます。</li> + </ul> + </dd> +</dl> + +<h3 id="Return_value" name="Return_value">戻り値</h3> + +<p><code>mode</code> 値に応じて、{{domxref("ReadableStreamDefaultReader")}} または {{domxref("ReadableStreamBYOBReader")}} オブジェクトのインスタンス。</p> + +<h3 id="Exceptions" name="Exceptions">例外</h3> + +<dl> + <dt>RangeError</dt> + <dd>指定された <code>mode</code> 値は <code>"byob"</code> または <code>undefined</code> ではありません。</dd> + <dt>TypeError</dt> + <dd>リーダーを作成しようとしているストリームは {{domxref("ReadableStream")}} ではありません。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<p>次の簡単な例では、<code>getReader()</code> を使用して作成した {{domxref("ReadableStreamDefaultReader")}} を使用して、以前に作成したカスタムの <code>ReadableStream</code> を読み取ります(完全なコードについては、<a href="https://mdn.github.io/dom-examples/streams/simple-random-stream/">単純なランダムストリームの例</a>を参照)。 各チャンクを順番に読み取り、ストリームの読み取りが完了するまで UI に出力します。 ストリームの読み取りが完了すると、再帰関数から戻り、ストリーム全体を UI の別の部分に出力します。</p> + +<pre class="brush: js">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 = value; + 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); + }); +}</pre> + +<h2 id="Specifications" name="Specifications">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName("Streams","#rs-get-reader","getReader()")}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + +<div class="hidden"> +<p>The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p> +</div> + +<p>{{Compat("api.ReadableStream.getReader")}}</p> |