files/ja/web/api/readablestreamdefaultcontroller/desiredsize/index.html


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

---
title: ReadableStreamDefaultController.desiredSize
slug: Web/API/ReadableStreamDefaultController/desiredSize
tags:
  - API
  - Property
  - ReadableStreamDefaultController
  - Reference
  - Streams
  - desiredSize
translation_of: Web/API/ReadableStreamDefaultController/desiredSize
---
<div>{{APIRef("Streams")}}</div>

<p class="summary"><span class="seoSummary">{{domxref("ReadableStreamDefaultController")}} インターフェイスの <strong><code>desiredSize</code></strong> 読み取り専用プロパティは、ストリームの内部キューを満たすために必要な希望サイズを返します。</span></p>

<h2 id="Syntax" name="Syntax">構文</h2>

<pre class="syntaxbox"><var><code>var <em>desiredSize</em> = </code>readableStreamDefaultController</var>.desiredSize;</pre>

<h3 id="Value" name="Value">値</h3>

<p>整数。 キューがいっぱいになった場合、これは負になる可能性があることに注意してください。</p>

<h2 id="Examples" name="Examples">例</h2>

<p>仕様にある<a href="https://streams.spec.whatwg.org/#example-rs-push-backpressure">基になるプッシュソースとバックプレッシャーサポートのある読み取り可能なストリーム</a>の例は、<code>desiredSize</code> を使用してストリームがいっぱいになったことを手動で検出し、バックプレッシャーを適用する良い例を示しています。 また、{{domxref("ReadablestreamDefaultController.error()")}} を使用して、依存しているシステムの別の部分に障害が発生した場合に手動でストリームのエラーをトリガーします。</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","#rs-default-controller-desired-size","desiredSize")}}</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 in 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.ReadableStreamDefaultController.desiredSize")}}</p>