blob: 411825e0c73ff3bcddf6ae0803682e5f622d8082 (
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
|
---
title: ReadableStreamBYOBReader.cancel()
slug: Web/API/ReadableStreamBYOBReader/cancel
tags:
- API
- Experimental
- Method
- ReadableStreamBYOBReader
- Reference
- Streams
- cancel
translation_of: Web/API/ReadableStreamBYOBReader/cancel
---
<div>{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}</div>
<p class="summary"><span class="seoSummary">{{domxref("ReadableStreamBYOBReader")}} インターフェイスの <strong><code>cancel()</code></strong> メソッドはストリームをキャンセルし、コンシューマーがストリームに興味を失ったことを通知します。 提供された <code>reason</code> パラメーターは、基になるソースに与えられ、使用する場合もしない場合もあります。</span></p>
<div class="note">
<p><strong>注</strong>：リーダーがアクティブな場合、<code>cancel()</code> メソッドは、関連するストリームの場合（{{domxref("ReadableStream.cancel()")}}）と同じように振る舞います。</p>
</div>
<h2 id="Syntax" name="Syntax">構文</h2>
<pre class="syntaxbox">var <em>promise</em> = <em>readableStreamBYOBReader</em>.cancel(<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>ソースオブジェクトが <code>ReadableStreamBYOBReader</code> ではないか、ストリームに所有者がいません。</dd>
</dl>
<h2 id="Examples" name="Examples">例</h2>
<p>未定。</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","#byob-reader-cancel","cancel()")}}</td>
<td>{{Spec2('Streams')}}</td>
<td>初期定義</td>
</tr>
</tbody>
</table>
<h2 id="Browser_compatibility" name="Browser_compatibility">ブラウザーの互換性</h2>
<p>{{Compat("api.ReadableStreamBYOBReader.cancel")}}</p>
|
