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/writablestreamdefaultwriter | |
| 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/writablestreamdefaultwriter')
9 files changed, 945 insertions, 0 deletions
diff --git a/files/ja/web/api/writablestreamdefaultwriter/abort/index.html b/files/ja/web/api/writablestreamdefaultwriter/abort/index.html new file mode 100644 index 0000000000..879e6e5cc1 --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/abort/index.html @@ -0,0 +1,88 @@ +--- +title: WritableStreamDefaultWriter.abort() +slug: Web/API/WritableStreamDefaultWriter/abort +tags: + - API + - Experimental + - Method + - Reference + - Streams + - WritableStreamDefaultWriter + - abort +translation_of: Web/API/WritableStreamDefaultWriter/abort +--- +<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div> + +<p class="summary"><span class="seoSummary">{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <strong><code>abort()</code></strong> メソッドはストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに書き込まれた書き込みを破棄してすぐにエラー状態に移行することを通知します。</span></p> + +<p>ライターがアクティブな場合、<code>abort()</code> メソッドは、関連するストリーム({{domxref("WritableStream.abort()")}})と同じように振る舞います。 そうでない場合、拒否された promise を返します。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <em>promise</em> = <em>writableStreamDefaultWriter</em>.abort(<em>reason</em>);</pre> + +<h3 id="Parameters" name="Parameters">パラメーター</h3> + +<dl> + <dt>reason {{optional_inline}}</dt> + <dd>人間が読むことができる中止の理由を提供する {{domxref("DOMString")}}。</dd> +</dl> + +<h3 id="Return_value" name="Return_value">戻り値</h3> + +<p>{{jsxref("Promise")}}。 <code>reason</code> パラメーターで指定された値で満たされます。</p> + +<h3 id="Exceptions" name="Exceptions">例外</h3> + +<dl> + <dt>TypeError</dt> + <dd>中止しようとしているストリームは {{domxref("WritableStream")}} ではないか、ロックされています。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<pre class="brush: js">const writableStream = new WritableStream({ + write(chunk) { + ... + }, + close() { + ... + }, + abort(err) { + ... + } +}, queuingStrategy); + +... + +const writer = writableStream.getWriter(); + +... + +// 必要に応じてストリームを中止します +writer.abort.then((reason) => { + console.log(reason); +})</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","#default-writer-abort","abort()")}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.abort")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/close/index.html b/files/ja/web/api/writablestreamdefaultwriter/close/index.html new file mode 100644 index 0000000000..6f827af2c4 --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/close/index.html @@ -0,0 +1,132 @@ +--- +title: WritableStreamDefaultWriter.close() +slug: Web/API/WritableStreamDefaultWriter/close +tags: + - API + - Experimental + - Method + - Reference + - Streams + - WritableStreamDefaultWriter + - close +translation_of: Web/API/WritableStreamDefaultWriter/close +--- +<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div> + +<p class="summary"><span class="seoSummary">{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <strong><code>close()</code></strong> メソッドは、関連する書き込み可能なストリームを閉じます。</span></p> + +<p>基になるシンクは、閉じる振る舞いを呼び出す前に、以前に書き込まれたチャンクの処理を終了します。 この間、それ以上の書き込み試行は失敗します(ストリームにエラーは発生しません)。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <em>promise</em> = <em>writableStreamDefaultWriter</em>.close();</pre> + +<h3 id="Parameters" name="Parameters">パラメーター</h3> + +<p>なし。</p> + +<h3 id="Return_value" name="Return_value">戻り値</h3> + +<p>{{jsxref("Promise")}}。 閉じる前に残りのチャンクがすべて正常に書き込まれた場合は <code>undefined</code> で満たされ、プロセス中に問題が発生した場合はエラーで拒否されます。</p> + +<h3 id="Exceptions" name="Exceptions">例外</h3> + +<dl> + <dt>TypeError</dt> + <dd>閉じようとしているストリームは {{domxref("WritableStream")}} ではありません。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<p>次の例は、カスタムのシンクと API 提供のキューイング戦略を使用した <code>WritableStream</code> の作成を示しています。 次に、<code>sendMessage()</code> という関数を呼び出し、新しく作成されたストリームと文字列を渡します。 この関数内で、{{domxref("WritableStreamDefaultWriter")}} のインスタンスを返すストリームの <code>getWriter()</code> メソッドを呼び出します。 <code>forEach()</code> 呼び出しを使用して、文字列の各チャンクをストリームに書き込みます。 最後に、<code>write()</code> および <code>close()</code> は、チャンクとストリームの成功または失敗に対処するための promise を返します。</p> + +<ul> +</ul> + +<pre class="brush: js">const list = document.querySelector('ul'); + +function sendMessage(message, writableStream) { + // defaultWriter は WritableStreamDefaultWriter 型です + const defaultWriter = writableStream.getWriter(); + const encoder = new TextEncoder(); + const encoded = encoder.encode(message, { stream: true }); + encoded.forEach((chunk) => { + defaultWriter.ready + .then(() => { + return defaultWriter.write(chunk); + }) + .then(() => { + console.log("Chunk written to sink."); + }) + .catch((err) => { + console.log("Chunk error:", err); + }); + }); + // ライターを閉じる前にすべてのチャンクが + // 確実に書き込まれるように、ready を再度呼び出します。 + defaultWriter.ready + .then(() => { + defaultWriter.close(); + }) + .then(() => { + console.log("All chunks written"); + }) + .catch((err) => { + console.log("Stream error:", err); + }); +} + +const decoder = new TextDecoder("utf-8"); +const queuingStrategy = new CountQueuingStrategy({ highWaterMark: 1 }); +let result = ""; +const writableStream = new WritableStream({ + // シンクの実装 + write(chunk) { + return new Promise((resolve, reject) => { + var buffer = new ArrayBuffer(2); + var view = new Uint16Array(buffer); + view[0] = chunk; + var decoded = decoder.decode(view, { stream: true }); + var listItem = document.createElement('li'); + listItem.textContent = "Chunk decoded: " + decoded; + list.appendChild(listItem); + result += decoded; + resolve(); + }); + }, + close() { + var listItem = document.createElement('li'); + listItem.textContent = "[MESSAGE RECEIVED] " + result; + list.appendChild(listItem); + }, + abort(err) { + console.log("Sink error:", err); + } +}, queuingStrategy); + +sendMessage("Hello, world.", writableStream);</pre> + +<p>完全なコードは、<a href="https://mdn.github.io/dom-examples/streams/simple-writer/">単純なライターの例</a>にあります。</p> + +<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","#default-writer-close","close()")}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.close")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/closed/index.html b/files/ja/web/api/writablestreamdefaultwriter/closed/index.html new file mode 100644 index 0000000000..f3580e629e --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/closed/index.html @@ -0,0 +1,74 @@ +--- +title: WritableStreamDefaultWriter.closed +slug: Web/API/WritableStreamDefaultWriter/closed +tags: + - API + - Experimental + - Property + - Reference + - Streams + - WritableStreamDefaultWriter + - closed +translation_of: Web/API/WritableStreamDefaultWriter/closed +--- +<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div> + +<p class="summary"><span class="seoSummary">{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <strong><code>closed</code></strong> 読み取り専用プロパティは、ストリームが閉じられた場合、またはライターのロックが解除された場合に満たし、ストリームがエラーの場合に拒否する promise を返します。</span></p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox"><var><code>var <em>closed</em> = </code>writableStreamDefaultWriter</var>.closed;</pre> + +<h3 id="Value" name="Value">値</h3> + +<p>{{jsxref("Promise")}}。</p> + +<h2 id="Examples" name="Examples">例</h2> + +<pre class="brush: js">const writableStream = new WritableStream({ + start(controller) { + }, + write(chunk, controller) { + ... + }, + close(controller) { + ... + }, + abort(err) { + ... + } +}, queuingStrategy); + +... + +const writer = writableStream.getWriter(); + +.. + +// ストリームが閉じているかどうかを確認します +writer.closed.then(() => { + console.log('writer closed'); +})</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","#default-writer-closed","closed")}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.closed")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/desiredsize/index.html b/files/ja/web/api/writablestreamdefaultwriter/desiredsize/index.html new file mode 100644 index 0000000000..d610622b1c --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/desiredsize/index.html @@ -0,0 +1,79 @@ +--- +title: WritableStreamDefaultWriter.desiredSize +slug: Web/API/WritableStreamDefaultWriter/desiredSize +tags: + - API + - Experimental + - Property + - Reference + - Streams + - WritableStreamDefaultWriter + - desiredSize +translation_of: Web/API/WritableStreamDefaultWriter/desiredSize +--- +<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div> + +<p class="summary"><span class="seoSummary">{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <strong><code>desiredSize</code></strong> 読み取り専用プロパティは、ストリームの内部キューを埋めるために必要な希望サイズを返します。</span></p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox"><var><code>var <em>desiredSize</em> = </code>writableStreamDefaultWriter</var>.desiredSize;</pre> + +<h3 id="Value" name="Value">値</h3> + +<p>整数。 キューがいっぱいになった場合、これは負になる可能性があることに注意してください。</p> + +<p>値は、(エラーが発生したか、中止がキューに入れられたために)ストリームに正常に書き込むことができない場合、<code>null</code> になり、ストリームが閉じられると <code>0</code> になります。</p> + +<h3 id="Exceptions" name="Exceptions">例外</h3> + +<dl> + <dt>TypeError</dt> + <dd>ライターのロックが解除されています。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">const</span> writableStream <span class="operator token">=</span> <span class="keyword token">new</span> <span class="class-name token">WritableStream</span><span class="punctuation token">(</span><span class="punctuation token">{</span> + <span class="function token">write</span><span class="punctuation token">(</span>chunk<span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">.</span> + <span class="punctuation token">}</span><span class="punctuation token">,</span> + <span class="function token">close</span><span class="punctuation token">(</span><span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">.</span> + <span class="punctuation token">}</span><span class="punctuation token">,</span> + <span class="function token">abort</span><span class="punctuation token">(</span>err<span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">.</span> + <span class="punctuation token">}</span> +<span class="punctuation token">}</span><span class="punctuation token">,</span> queuingStrategy<span class="punctuation token">)</span><span class="punctuation token">;</span> + +<span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">. + +</span></code><code class="language-js"><span class="punctuation token">const writer = writableStream.getWriter(); + +...</span></code><code class="language-js"> + +<span class="comment token">// ストリームの希望サイズを返します</span> +let size = writer<span class="punctuation token">.</span>desiredSize;</code></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","#default-writer-desired-size","desiredSize")}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.desiredSize")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/index.html b/files/ja/web/api/writablestreamdefaultwriter/index.html new file mode 100644 index 0000000000..06e5135823 --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/index.html @@ -0,0 +1,142 @@ +--- +title: WritableStreamDefaultWriter +slug: Web/API/WritableStreamDefaultWriter +tags: + - API + - Experimental + - Interface + - Reference + - Streams + - Streams API + - WritableStream +translation_of: Web/API/WritableStreamDefaultWriter +--- +<p>{{SeeCompatTable}}{{APIRef("Streams")}}</p> + +<p><span class="seoSummary"><a href="/ja/docs/Web/API/Streams_API">Streams API</a> の <strong><code>WritableStreamDefaultWriter</code></strong> インターフェイスは、{{domxref("WritableStream.getWriter()")}} によって返されるオブジェクトであり、作成されるとライターを <code>WritableStream</code> にロックし、他のストリームが基になるシンクに書き込めないようにします。</span></p> + +<h2 id="Constructor" name="Constructor">コンストラクター</h2> + +<dl> + <dt>{{domxref("WritableStreamDefaultWriter.WritableStreamDefaultWriter", "WritableStreamDefaultWriter()")}}</dt> + <dd>新しい <code>WritableStreamDefaultWriter</code> オブジェクトのインスタンスを作成します。</dd> +</dl> + +<h2 id="Properties" name="Properties">プロパティ</h2> + +<dl> + <dt>{{domxref("WritableStreamDefaultWriter.closed")}}{{readonlyinline}}</dt> + <dd>ストリーミングプロセスの終了に応答するコードを記述できます。 ストリームが閉じられるか、ライターのロックが解除されると満たされる promise を返します。 ストリームがエラーになると拒否します。</dd> + <dt>{{domxref("WritableStreamDefaultWriter.desiredSize")}}{{readonlyinline}}</dt> + <dd>ストリームの内部キューを満たすために必要な希望サイズを返します。</dd> + <dt>{{domxref("WritableStreamDefaultWriter.ready")}}{{readonlyinline}}</dt> + <dd>ストリームの内部キューの希望サイズが非正から正に移行したときに解決する {{jsxref("Promise")}} を返し、バックプレッシャーが適用されなくなったことを通知します。</dd> +</dl> + +<h2 id="Methods" name="Methods">メソッド</h2> + +<dl> + <dt>{{domxref("WritableStreamDefaultWriter.abort()")}}</dt> + <dd>ストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに入れられた書き込みを破棄してすぐにエラー状態に移行することを通知します。</dd> + <dt>{{domxref("WritableStreamDefaultWriter.close()")}}</dt> + <dd>関連する書き込み可能なストリームを閉じます。</dd> + <dt>{{domxref("WritableStreamDefaultWriter.releaseLock()")}}</dt> + <dd>対応するストリームのライターのロックを解除します。 ロックを解除すると、ライターはアクティブではなくなります。 ロックを解除したときに関連するストリームにエラーが発生した場合、ライターはこれ以降同じようにエラーが発生したように見えます。 そうでない場合、ライターは閉じられたように見えます。</dd> + <dt>{{domxref("WritableStreamDefaultWriter.write()")}}</dt> + <dd>渡されたデータのチャンクを {{domxref("WritableStream")}} とその基になるシンクに書き込んでから、書き込み操作の成功または失敗を示すために解決する {{jsxref("Promise")}} を返します。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<p>次の例は、カスタムのシンクと API 提供のキューイング戦略を使用した <code>WritableStream</code> の作成を示しています。 次に、<code>sendMessage()</code> という関数を呼び出し、新しく作成されたストリームと文字列を渡します。 この関数内で、{{domxref("WritableStreamDefaultWriter")}} のインスタンスを返すストリームの <code>getWriter()</code> メソッドを呼び出します。 <code>forEach()</code> 呼び出しを使用して、文字列の各チャンクをストリームに書き込みます。 最後に、<code>write()</code> および <code>close()</code> は、チャンクとストリームの成功または失敗に対処するための promise を返します。</p> + +<ul> +</ul> + +<pre class="brush: js">const list = document.querySelector('ul'); + +function sendMessage(message, writableStream) { + // defaultWriter は WritableStreamDefaultWriter 型です + const defaultWriter = writableStream.getWriter(); + const encoder = new TextEncoder(); + const encoded = encoder.encode(message, { stream: true }); + encoded.forEach((chunk) => { + defaultWriter.ready + .then(() => { + return defaultWriter.write(chunk); + }) + .then(() => { + console.log("Chunk written to sink."); + }) + .catch((err) => { + console.log("Chunk error:", err); + }); + }); + // ライターを閉じる前にすべてのチャンクが + // 確実に書き込まれるように、ready を再度呼び出します。 + defaultWriter.ready + .then(() => { + defaultWriter.close(); + }) + .then(() => { + console.log("All chunks written"); + }) + .catch((err) => { + console.log("Stream error:", err); + }); +} + +const decoder = new TextDecoder("utf-8"); +const queuingStrategy = new CountQueuingStrategy({ highWaterMark: 1 }); +let result = ""; +const writableStream = new WritableStream({ + // シンクの実装 + write(chunk) { + return new Promise((resolve, reject) => { + var buffer = new ArrayBuffer(2); + var view = new Uint16Array(buffer); + view[0] = chunk; + var decoded = decoder.decode(view, { stream: true }); + var listItem = document.createElement('li'); + listItem.textContent = "Chunk decoded: " + decoded; + list.appendChild(listItem); + result += decoded; + resolve(); + }); + }, + close() { + var listItem = document.createElement('li'); + listItem.textContent = "[MESSAGE RECEIVED] " + result; + list.appendChild(listItem); + }, + abort(err) { + console.log("Sink error:", err); + } +}, queuingStrategy); + +sendMessage("Hello, world.", writableStream);</pre> + +<p>完全なコードは、<a href="https://mdn.github.io/dom-examples/streams/simple-writer/">単純なライターの例</a>にあります。</p> + +<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','#default-writer-class','WritableStreamDefaultWriter')}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/ready/index.html b/files/ja/web/api/writablestreamdefaultwriter/ready/index.html new file mode 100644 index 0000000000..da3c6620d0 --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/ready/index.html @@ -0,0 +1,85 @@ +--- +title: WritableStreamDefaultWriter.ready +slug: Web/API/WritableStreamDefaultWriter/ready +tags: + - API + - Property + - Ready + - Reference + - Streams + - Streams API + - WritableStream + - WritableStreamDefaultWriter +translation_of: Web/API/WritableStreamDefaultWriter/ready +--- +<p>{{SeeCompatTable}}{{APIRef("Streams")}}</p> + +<p>{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <strong><code>ready</code></strong> 読み取り専用プロパティは、ストリームの内部キューの目的のサイズが非正から正に移行したときに解決する {{jsxref("Promise")}} を返し、バックプレッシャーが適用されなくなったことを通知します。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <em>promise</em> = <em>writableStreamDefaultWriter</em>.ready;</pre> + +<h3 id="Value" name="Value">値</h3> + +<p>{{jsxref("Promise")}}。</p> + +<h2 id="Example" name="Example">例</h2> + +<p>次の例は、<code>ready</code> プロパティの2つの使用法を示しています。 最初は <code>ready</code> を使用して、<code>WritableStream</code> が書き込みを完了し、バイナリチャンクを送信する前にデータを受信できるようにします。 2番目も、<code>WritableStream</code> の書き込みが完了しているかどうかをチェックしますが、今度はライターを閉じる前に書き込みを終了する必要があるためです。</p> + +<pre class="brush: js">function sendMessage(message, writableStream) { + // defaultWriter は WritableStreamDefaultWriter 型です + var defaultWriter = writableStream.getWriter(); + var encoder = new TextEncoder(); + var encoded = encoder.encode(message, {stream: true}); + encoded.forEach(function(chunk) { + // ストリームとそのライターがデータを + // 受信できることを確認します。 + defaultWriter.ready + .then(function() { + defaultWriter.write(chunk) + .then(function() { + console.log("Chunk written to sink.); + }) + .catch(function(err) { + console.log("Chunk error: " + err); + }); + }); + // ライターを閉じる前にすべてのチャンクが + // 確実に書き込まれるように、ready を再度呼び出します。 + defaultWriter.ready + .then(function() { + defaultWriter.close() + .then(function() { + console.log("All chunks written"); + }) + .catch(function(err) { + console.log("Stream error: " + err); + }); + }); + }); +}</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','#default-writer-ready','ready')}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_Compatibility" name="Browser_Compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.ready")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/releaselock/index.html b/files/ja/web/api/writablestreamdefaultwriter/releaselock/index.html new file mode 100644 index 0000000000..7f34177f1c --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/releaselock/index.html @@ -0,0 +1,74 @@ +--- +title: WritableStreamDefaultWriter.releaseLock() +slug: Web/API/WritableStreamDefaultWriter/releaseLock +tags: + - API + - Experimental + - Method + - Reference + - Streams + - WritiableStream + - releaseLock +translation_of: Web/API/WritableStreamDefaultWriter/releaseLock +--- +<p>{{APIRef("Streams")}}{{SeeCompatTable}}{{draft}}</p> + +<p>{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <span class="seoSummary"><strong><code>releaseLock()</code></strong> メソッドは、対応するストリームのライターのロックを解除します。 ロックを解除すると、ライターはアクティブではなくなります。 ロックを解除したときに関連するストリームにエラーが発生した場合、ライターはこれ以降同じようにエラーが発生したように見えます。 そうでない場合、ライターは閉じられたように見えます。</span></p> + +<h2 id="構文">構文</h2> + +<pre class="syntaxbox"><em>writableStreamDefaultWritere</em>.releaseLock()</pre> + +<h3 id="パラメーター">パラメーター</h3> + +<p>なし。</p> + +<h3 id="戻り値">戻り値</h3> + +<p><code>undefined</code>。</p> + +<h2 id="例">例</h2> + +<pre class="brush: js line-numbers language-js"><code class="language-js"><span class="keyword token">const</span> writableStream <span class="operator token">=</span> <span class="keyword token">new</span> <span class="class-name token">WritableStream</span><span class="punctuation token">(</span><span class="punctuation token">{</span> + <span class="function token">write</span><span class="punctuation token">(</span>chunk<span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">.</span> + <span class="punctuation token">}</span><span class="punctuation token">,</span> + <span class="function token">close</span><span class="punctuation token">(</span><span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">.</span> + <span class="punctuation token">}</span><span class="punctuation token">,</span> + <span class="function token">abort</span><span class="punctuation token">(</span>err<span class="punctuation token">)</span> <span class="punctuation token">{</span> + <span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">.</span> + <span class="punctuation token">}</span> +<span class="punctuation token">}</span><span class="punctuation token">,</span> queuingStrategy<span class="punctuation token">)</span><span class="punctuation token">;</span> + +<span class="punctuation token">.</span><span class="punctuation token">.</span><span class="punctuation token">. + +const writer = writableStream.getWriter(); + +...</span> + +<span class="comment token">// 必要に応じて、ストリームのライターのロックを解除します</span> +writer<span class="punctuation token">.</span><span class="punctuation token">releaseLock();</span></code></pre> + +<h2 id="仕様">仕様</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">仕様</th> + <th scope="col">状態</th> + <th scope="col">コメント</th> + </tr> + <tr> + <td>{{SpecName('Streams','#default-reader-release-lock','releaseLock()')}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="ブラウザーの互換性">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.releaseLock")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/writablestreamdefaultwriter/index.html b/files/ja/web/api/writablestreamdefaultwriter/writablestreamdefaultwriter/index.html new file mode 100644 index 0000000000..f731c00afa --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/writablestreamdefaultwriter/index.html @@ -0,0 +1,136 @@ +--- +title: WritableStreamDefaultWriter.WritableStreamDefaultWriter() +slug: Web/API/WritableStreamDefaultWriter/WritableStreamDefaultWriter +tags: + - API + - Constructor + - Experimental + - Reference + - Streams + - WritableStreamDefaultWriter +translation_of: Web/API/WritableStreamDefaultWriter/WritableStreamDefaultWriter +--- +<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div> + +<p class="summary"><strong><code>WritableStreamDefaultWriter()</code></strong> コンストラクターは、新しい {{domxref("WritableStreamDefaultWriter")}} オブジェクトのインスタンスを作成します。</p> + +<div class="note"> +<p><strong>注</strong>: 通常、このコンストラクターを手動で使用することはありません。 代わりに、{{domxref("WritableStream.getWriter()")}} メソッドを使用します。</p> +</div> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <em>writableStreamDefaultWriter</em> = new WritableStreamDefaultWriter(<em>stream</em>);</pre> + +<h3 id="Parameters" name="Parameters">パラメーター</h3> + +<dl> + <dt>stream</dt> + <dd>書き込む {{domxref("WritableStream")}}。</dd> +</dl> + +<h3 id="Return_value" name="Return_value">戻り値</h3> + +<p>{{domxref("WritableStreamDefaultWriter")}} オブジェクトのインスタンス。</p> + +<h3 id="Exceptions" name="Exceptions">例外</h3> + +<dl> + <dt>TypeError</dt> + <dd>指定された <code>stream</code> 値は {{domxref("WritableStream")}} ではないか、すでに別のライターにロックされています。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<p>次の例は、カスタムのシンクと API 提供のキューイング戦略を使用した <code>WritableStream</code> の作成を示しています。 次に、<code>sendMessage()</code> という関数を呼び出し、新しく作成されたストリームと文字列を渡します。 この関数内で、{{domxref("WritableStreamDefaultWriter")}} のインスタンスを返すストリームの <code>getWriter()</code> メソッドを呼び出します。 <code>forEach()</code> 呼び出しを使用して、文字列の各チャンクをストリームに書き込みます。 最後に、<code>write()</code> および <code>close()</code> は、チャンクとストリームの成功または失敗に対処するための promise を返します。</p> + +<ul> +</ul> + +<pre class="brush: js">const list = document.querySelector('ul'); + +function sendMessage(message, writableStream) { + // defaultWriter は WritableStreamDefaultWriter 型です + const defaultWriter = writableStream.getWriter(); + const encoder = new TextEncoder(); + const encoded = encoder.encode(message, { stream: true }); + encoded.forEach((chunk) => { + defaultWriter.ready + .then(() => { + return defaultWriter.write(chunk); + }) + .then(() => { + console.log("Chunk written to sink."); + }) + .catch((err) => { + console.log("Chunk error:", err); + }); + }); + // ライターを閉じる前にすべてのチャンクが + // 確実に書き込まれるように、ready を再度呼び出します。 + defaultWriter.ready + .then(() => { + defaultWriter.close(); + }) + .then(() => { + console.log("All chunks written"); + }) + .catch((err) => { + console.log("Stream error:", err); + }); +} + +const decoder = new TextDecoder("utf-8"); +const queuingStrategy = new CountQueuingStrategy({ highWaterMark: 1 }); +let result = ""; +const writableStream = new WritableStream({ + // シンクの実装 + write(chunk) { + return new Promise((resolve, reject) => { + var buffer = new ArrayBuffer(2); + var view = new Uint16Array(buffer); + view[0] = chunk; + var decoded = decoder.decode(view, { stream: true }); + var listItem = document.createElement('li'); + listItem.textContent = "Chunk decoded: " + decoded; + list.appendChild(listItem); + result += decoded; + resolve(); + }); + }, + close() { + var listItem = document.createElement('li'); + listItem.textContent = "[MESSAGE RECEIVED] " + result; + list.appendChild(listItem); + }, + abort(err) { + console.log("Sink error:", err); + } +}, queuingStrategy); + +sendMessage("Hello, world.", writableStream);</pre> + +<p>完全なコードは、<a href="https://mdn.github.io/dom-examples/streams/simple-writer/">単純なライターの例</a>にあります。</p> + +<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","#default-writer-constructor","WritableStreamDefaultWriter()")}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.WritableStreamDefaultWriter")}}</p> diff --git a/files/ja/web/api/writablestreamdefaultwriter/write/index.html b/files/ja/web/api/writablestreamdefaultwriter/write/index.html new file mode 100644 index 0000000000..8aa47a52cc --- /dev/null +++ b/files/ja/web/api/writablestreamdefaultwriter/write/index.html @@ -0,0 +1,135 @@ +--- +title: WritableStreamDefaultWriter.write() +slug: Web/API/WritableStreamDefaultWriter/write +tags: + - API + - Experimental + - Method + - Reference + - Streams + - WritableStreamDefaultWriter + - write +translation_of: Web/API/WritableStreamDefaultWriter/write +--- +<p>{{APIRef("Streams")}}{{SeeCompatTable}}</p> + +<p><span class="seoSummary">{{domxref("WritableStreamDefaultWriter")}} インターフェイスの <strong><code>write()</code></strong> プロパティは、渡されたデータのチャンクを {{domxref("WritableStream")}} とその基になるシンクに書き込み、その後、書き込み操作の成功または失敗を示すために解決される {{jsxref("Promise")}} を返します。</span></p> + +<p>「成功」の意味は、基になるシンク次第であることに注意してください。 単にチャンクが受け入れられたことを示しているだけで、必ずしも最終的な宛先に安全に保存されているとは限りません。</p> + +<h2 id="Syntax" name="Syntax">構文</h2> + +<pre class="syntaxbox">var <em>promise</em> = <em>writableStreamDefaultWriter</em>.write(<em>chunk</em>);</pre> + +<h3 id="Parameters" name="Parameters">パラメーター</h3> + +<dl> + <dt>chunk</dt> + <dd><code>WritableStream</code> に渡すバイナリデータのブロック。</dd> +</dl> + +<h3 id="Return_value" name="Return_value">戻り値</h3> + +<p>{{jsxref("Promise")}}。 書き込みが成功すると <code>undefined</code> で満たされ、書き込みプロセスが開始される前に書き込みが失敗するかストリームがエラーになると拒否されます。</p> + +<h3 id="Exceptions" name="Exceptions">例外</h3> + +<dl> + <dt>TypeError</dt> + <dd>対象のストリームは書き込み可能なストリームではないか、所有者がいません。</dd> +</dl> + +<h2 id="Examples" name="Examples">例</h2> + +<p>次の例は、カスタムのシンクと API 提供のキューイング戦略を使用した <code>WritableStream</code> の作成を示しています。 次に、<code>sendMessage()</code> という関数を呼び出し、新しく作成されたストリームと文字列を渡します。 この関数内で、{{domxref("WritableStreamDefaultWriter")}} のインスタンスを返すストリームの <code>getWriter()</code> メソッドを呼び出します。 <code>forEach()</code> 呼び出しを使用して、文字列の各チャンクをストリームに書き込みます。 最後に、<code>write()</code> および <code>close()</code> は、チャンクとストリームの成功または失敗に対処するための promise を返します。</p> + +<ul> +</ul> + +<pre class="brush: js">const list = document.querySelector('ul'); + +function sendMessage(message, writableStream) { + // defaultWriter は WritableStreamDefaultWriter 型です + const defaultWriter = writableStream.getWriter(); + const encoder = new TextEncoder(); + const encoded = encoder.encode(message, { stream: true }); + encoded.forEach((chunk) => { + defaultWriter.ready + .then(() => { + return defaultWriter.write(chunk); + }) + .then(() => { + console.log("Chunk written to sink."); + }) + .catch((err) => { + console.log("Chunk error:", err); + }); + }); + // ライターを閉じる前にすべてのチャンクが + // 確実に書き込まれるように、ready を再度呼び出します。 + defaultWriter.ready + .then(() => { + defaultWriter.close(); + }) + .then(() => { + console.log("All chunks written"); + }) + .catch((err) => { + console.log("Stream error:", err); + }); +} + +const decoder = new TextDecoder("utf-8"); +const queuingStrategy = new CountQueuingStrategy({ highWaterMark: 1 }); +let result = ""; +const writableStream = new WritableStream({ + // シンクの実装 + write(chunk) { + return new Promise((resolve, reject) => { + var buffer = new ArrayBuffer(2); + var view = new Uint16Array(buffer); + view[0] = chunk; + var decoded = decoder.decode(view, { stream: true }); + var listItem = document.createElement('li'); + listItem.textContent = "Chunk decoded: " + decoded; + list.appendChild(listItem); + result += decoded; + resolve(); + }); + }, + close() { + var listItem = document.createElement('li'); + listItem.textContent = "[MESSAGE RECEIVED] " + result; + list.appendChild(listItem); + }, + abort(err) { + console.log("Sink error:", err); + } +}, queuingStrategy); + +sendMessage("Hello, world.", writableStream);</pre> + +<p>完全なコードは、<a href="https://mdn.github.io/dom-examples/streams/simple-writer/">単純なライターの例</a>にあります。</p> + +<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','#default-writer-write','write()')}}</td> + <td>{{Spec2('Streams')}}</td> + <td>初期定義</td> + </tr> + </tbody> +</table> + +<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2> + + + +<p>{{Compat("api.WritableStreamDefaultWriter.write")}}</p> |
