blob: 64c180fac8b49c87b1fd43e71928da66aabd77ea (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
---
title: WritableStream.abort()
slug: Web/API/WritableStream/abort
tags:
- API
- Experimental
- Method
- Reference
- Streams
- WritableStream
- abort
translation_of: Web/API/WritableStream/abort
---
<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div>
<p class="summary"><span class="seoSummary">{{domxref("WritableStream")}} インターフェイスの <strong><code>abort()</code></strong> メソッドはストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに入れられた書き込みが破棄されてすぐにエラー状態に移行することを通知します。</span></p>
<h2 id="Syntax" name="Syntax">構文</h2>
<pre class="syntaxbox">var <em>promise</em> = <em>writableStream</em>.abort(<em>reason</em>);</pre>
<h3 id="Parameters" name="Parameters">パラメーター</h3>
<dl>
<dt>reason</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 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="function token">close</span><span class="punctuation token">(</span><span class="punctuation token">)</span> <span class="punctuation token">{</span>
<span class="keyword 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> queuingStrategy<span class="punctuation token">)</span><span class="punctuation token">;</span>
...
// 必要に応じて、後でストリームを中止します
writableStream.abort();
</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","#ws-abort","abort()")}}</td>
<td>{{Spec2('Streams')}}</td>
<td>初期定義</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>
<p>{{Compat("api.WritableStream.abort")}}</p>
|
