From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- .../web/api/readablestream/getreader/index.html | 103 ++++++++++++++++++ files/zh-cn/web/api/readablestream/index.html | 114 ++++++++++++++++++++ .../api/readablestream/readablestream/index.html | 117 +++++++++++++++++++++ 3 files changed, 334 insertions(+) create mode 100644 files/zh-cn/web/api/readablestream/getreader/index.html create mode 100644 files/zh-cn/web/api/readablestream/index.html create mode 100644 files/zh-cn/web/api/readablestream/readablestream/index.html (limited to 'files/zh-cn/web/api/readablestream') diff --git a/files/zh-cn/web/api/readablestream/getreader/index.html b/files/zh-cn/web/api/readablestream/getreader/index.html new file mode 100644 index 0000000000..bddbcf0bae --- /dev/null +++ b/files/zh-cn/web/api/readablestream/getreader/index.html @@ -0,0 +1,103 @@ +--- +title: ReadableStream.getReader() +slug: Web/API/ReadableStream/getReader +tags: + - API + - getReader + - 参考 + - 可读取流 + - 方法 + - 流 +translation_of: Web/API/ReadableStream/getReader +--- +
{{APIRef("Streams")}}
+ +

使用{{domxref("ReadableStream")}}接口的getReader() 方法创建一个reader，并将流锁定。只有当前reader将流释放后，其他reader才能使用。

+ +

语法

+ +
var reader = readableStreamInstance.getReader({mode});
+ +

参数

+ +
+
{mode}- 可选参数
+
具有 mode参数的对象，值为  {{domxref("DOMString")}}类型 ,用来指定要创建的阅读器的类型。其值可以是： +
    +
  • byob, 结果为 {{domxref("ReadableStreamBYOBReader")}} 类型，可读取可读字节流。
    • +
  • undefined (未定类型 — 默认值), 返回{{domxref("ReadableStreamDefaultReader")}} ，可以从流中返回单个块。
    • +
+
+
+ +

返回值

+ +

{{domxref("ReadableStreamDefaultReader")}} 类型或{{domxref("ReadableStreamBYOBReader")}} 类型 实例, 取决于 mode 值.

+ +

错误

+ +
+
RangeError——范围错误
+
提供的 mode值 既不是 byob也不是  undefined
+
TypeError——类型错误
+
尝试创建阅读器的流不是 {{domxref("ReadableStream")}}类型
+
+ +

例子

+ +

下面是个简单的例子, 在读取ReadableStream前，使用 getReader()创建一个{{domxref("ReadableStreamDefaultReader")}} 。(查看全部代码 Simple random stream example ). 按顺序读取每个块，并传递给UI, 当整个流被读取完毕后, 从递归方法中退出，并在UI的另一部分输出整个流。

+ +
function fetchStream() {
+  const reader = stream.getReader();
+  let charsReceived = 0;
+
+  // read() 返回了一个promise
+  // 当数据被接收时resolve
+  reader.read().then(function processText({ done, value }) {
+    // Result对象包含了两个属性:
+    // done  - 当stream传完所有数据时则变成true
+    // value - 数据片段。当done不为true时永远为undefined
+    if (done) {
+      console.log("Stream complete");
+      para.textContent = value;
+      return;
+    }
+
+    // value for fetch streams is a Uint8Array
+    charsReceived += value.length;
+    const chunk = value;
+    let listItem = document.createElement('li');
+    listItem.textContent = 'Received ' + charsReceived + ' characters so far. Current chunk = ' + chunk;
+    list2.appendChild(listItem);
+
+    result += chunk;
+
+    // 再次调用这个函数以读取更多数据
+    return reader.read().then(processText);
+  });
+}
+ +

说明

+ + + + + + + + + + + + + + +
SpecificationStatus(状态)Comment(备注)
{{SpecName("Streams","#rs-get-reader","getReader()")}}{{Spec2('Streams')}}Initial definition.
+ +

浏览器兼容

+ + + +

{{Compat("api.ReadableStream.getReader")}}

diff --git a/files/zh-cn/web/api/readablestream/index.html b/files/zh-cn/web/api/readablestream/index.html new file mode 100644 index 0000000000..445fc134d1 --- /dev/null +++ b/files/zh-cn/web/api/readablestream/index.html @@ -0,0 +1,114 @@ +--- +title: ReadableStream +slug: Web/API/ReadableStream +tags: + - API + - Fetch + - ReadableStream + - 引用 + - 接口 +translation_of: Web/API/ReadableStream +--- +

{{APIRef("Fetch")}}

+ +

流操作API 中的ReadableStream 接口呈现了一个可读取的二进制流操作。Fetch API 通过 {{domxref("Response")}} 的属性 {{domxref("Body.body", "body")}} 提供了一个具体的 ReadableStream 对象。

+ +

构造函数

+ +
+
{{domxref("ReadableStream.ReadableStream", "ReadableStream()")}}
+
创建并从给定的 Handler 返回一个可读流对象。
+
+ +

属性

+ +
+
{{domxref("ReadableStream.locked")}} {{readonlyInline}}
+
locked 返回这个可读流是否被一个读取器锁定。
+
+ +

方法

+ +
+
{{domxref("ReadableStream.cancel()")}}
+
取消读取流，读取方发出一个信号，表示对这束流失去兴趣。可以传入 reason 参数表示取消原因，这个原因将传回给调用方。
+
{{domxref("ReadableStream.getIterator()")}}
+
创建一个异步的 ReadableStream 迭代器并将流锁定于其上。一旦流被锁定，其他读取器将不能读取它，直到它被释放。
+
{{domxref("ReadableStream.getReader()")}}
+
创建一个读取器并将流锁定于其上。一旦流被锁定，其他读取器将不能读取它，直到它被释放。
+
+ +
+
{{domxref("ReadableStream.pipeThrough()")}}
+
提供将当前流管道输出到一个 transform 流或 writable/readable 流对的链式方法。
+
+ +
+
{{domxref("ReadableStream.pipeTo()")}}
+
将当前 ReadableStream 管道输出到给定的 {{domxref("WritableStream")}}，并返回一个 promise，输出过程成功时返回 fulfilled，在发生错误时返回 rejected。
+
{{domxref("ReadableStream.tee()")}}
+
tee 方法（tee本意是将高尔夫球放置在球座上）tees 了可读流，返回包含两个{{domxref("ReadableStream")}} 实例分支的数组，每个元素接收了相同的传输数据。
+
{{domxref("ReadableStream[@@asyncIterator]()")}}
+
getIterator 方法的别名。
+
+ +

示例

+ +

下面的例子，创建了一个智能的 {{domxref("Response")}} 来流式化从别的资源处取得的HTML 片段。

+ +

它演示了 {{domxref("ReadableStream")}} 与 {{domxref("Uint8Array")}} 的协同用法。

+ +
fetch("https://www.example.org/").then((response) => {
+  const reader = response.body.getReader();
+  const stream = new ReadableStream({
+    start(controller) {
+      // 下面的函数处理每个数据块
+      function push() {
+        // "done"是一个布尔型，"value"是一个Unit8Array
+        reader.read().then(({ done, value }) => {
+          // 判断是否还有可读的数据？
+          if (done) {
+            // 告诉浏览器已经结束数据发送
+            controller.close();
+            return;
+          }
+
+          // 取得数据并将它通过controller发送给浏览器
+          controller.enqueue(value);
+          push();
+        });
+      };
+
+      push();
+    }
+  });
+
+  return new Response(stream, { headers: { "Content-Type": "text/html" } });
+});
+ +

规范

+ + + + + + + + + + + + + + +
SpecificationStatusComment
{{SpecName('Streams','#rs-class','ReadableStream')}}{{Spec2('Streams')}}初始定义
+ +

浏览器兼容性

+ +

{{Compat("api.ReadableStream")}}

+ +

相关链接

+ + diff --git a/files/zh-cn/web/api/readablestream/readablestream/index.html b/files/zh-cn/web/api/readablestream/readablestream/index.html new file mode 100644 index 0000000000..14341ef8c2 --- /dev/null +++ b/files/zh-cn/web/api/readablestream/readablestream/index.html @@ -0,0 +1,117 @@ +--- +title: ReadableStream.ReadableStream() +slug: Web/API/ReadableStream/ReadableStream +translation_of: Web/API/ReadableStream/ReadableStream +--- +
{{draft}}{{SeeCompatTable}}{{APIRef("Streams")}}
+ +

ReadableStream() 构造器创建并返回包含处理函数的可读流实例.

+ +

语法

+ +
var readableStream = new ReadableStream(underlyingSource[, queueingStrategy]);
+ +

参数

+ +
+
underlyingSource
+
一个包含定义了构造流行为方法和属性的对象.underlyingSource 包括: +
+
start(controller)
+
这是一个当对象被构造时立刻调用的方法.此方法的内容由开发人员定义，并应着眼于访问流,并执行其他任何必需的设置流功能.如果这个过程是异步完成的，它可以返回一个promise，表明成功或失败.传递给这个方法的controller是一个{{domxref("ReadableStreamDefaultController")}}或{{domxref("ReadableByteStreamController")}},具体取决于type属性的值。开发人员可以使用此方法在设立期间控制流.
+
pull(controller) {{optional_inline}}
+
这个方法，也是由开发人员定义的，当流的内部队列不满时，会重复调用这个方法，直到队列补满。如果pull()返回一个promise，那么它将不会再被调用，直到promise完成;如果promise失败，该流将会出现错误.传递给此方法的controller参数是{{domxref("ReadableStreamDefaultController")}}或{{domxref("ReadableByteStreamController")}},具体取决于type属性的值。由于更多的块被获取,这个方法可以被开发人员用来控制流.
+
cancel(reason) {{optional_inline}}
+
如果应用程序表示该流将被取消（例如,调用了{{domxref("ReadableStream.cancel()")}}，则将调用此方法，该方法也由开发人员定义。 该方法应该做任何必要的事情来释放对流的访问。 如果这个过程是异步的，它可以返回一个promise,表明成功或失败.原因参数包含一个{{domxref("DOMString")}},它描述了流被取消的原因.
+
type {{optional_inline}}
+
该属性控制正在处理的可读类型的流。如果它包含一个设置为bytes的值，则传递的控制器对象将是一个{{domxref("ReadableByteStreamController")}}，能够处理BYOB（带您自己的缓冲区）/字节流。如果未包含，则传递的控制器将为{{domxref("ReadableStreamDefaultController")}}。
+
autoAllocateChunkSize {{optional_inline}}
+
对于字节流，开发人员可以使用正整数值设置autoAllocateChunkSize 以打开流的自动分配功能。启用此功能后，流实现将自动分配一个具有给定整数大小的{{domxref("ArrayBuffer")}}，并调用底层源代码，就好像消费者正在使用BYOB阅读器一样。
+
+
+
queueingStrategy {{optional_inline}}
+
一个可选择定义流的排队策略的对象。这需要两个参数： +
+
highWaterMark
+
非负整数 - 这定义了在应用背压之前可以包含在内部队列中的块的总数。
+
size(chunk)
+
包含参数chunk 的方法 - 这表示每个块使用的大小（以字节为单位）.
+
+ +
+

Note: You could define your own custom queueingStrategy, or use an instance of {{domxref("ByteLengthQueueingStrategy")}} or {{domxref("CountQueueingStrategy")}} for this object value. If no queueingStrategy is supplied, the default used is the same as a CountQueuingStrategy with a high water mark of 1.

+
+
+
+ +

返回值

+ +

{{domxref("ReadableStream")}}对象的实例.

+ +

错误

+ +
+
RangeError
+
提供的值既不是bytes也不是undefined.
+
+ +

例子

+ +

In the following simple example, a custom ReadableStream is created using a constructor (see our Simple random stream example for the full code). The start() function generates a random string of text every second and enqueues it into the stream. A cancel() fuction is also provided to stop the generation if {{domxref("ReadableStream.cancel()")}} is called for any reason.

+ +

When a button is pressed, the generation is stopped, the stream is closed using {{domxref("ReadableStreamDefaultController.close()")}}, and another function is run, which reads the data back out of the stream.

+ +
const stream = new ReadableStream({
+  start(controller) {
+    interval = setInterval(() => {
+      let string = randomChars();
+
+      // Add the string to the stream
+      controller.enqueue(string);
+
+      // show it on the screen
+      let listItem = document.createElement('li');
+      listItem.textContent = string;
+      list1.appendChild(listItem);
+    }, 1000);
+
+    button.addEventListener('click', function() {
+      clearInterval(interval);
+      fetchStream();
+      controller.close();
+    })
+  },
+  pull(controller) {
+    // We don't really need a pull in this example
+  },
+  cancel() {
+    // This is called if the reader cancels,
+    // so we should stop generating strings
+    clearInterval(interval);
+  }
+});
+ +

Specifications

+ + + + + + + + + + + + + + +
SpecificationStatusComment
{{SpecName("Streams","#rs-constructor","ReadableStream()")}}{{Spec2('Streams')}}Initial definition.
+ +

Browser compatibility

+ + + +

{{Compat("api.ReadableStream.ReadableStream")}}

-- cgit v1.2.3-54-g00ecf