diff options
Diffstat (limited to 'files/ja/web/api/writablestreamdefaultwriter/abort/index.html')
| -rw-r--r-- | files/ja/web/api/writablestreamdefaultwriter/abort/index.html | 88 |
1 files changed, 88 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> |
