dom/webidl/ReadableStreamDefaultReader.webidl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   4  * You can obtain one at http://mozilla.org/MPL/2.0/.
   5  *
   6  * The origin of this IDL file is
   7  * https://streams.spec.whatwg.org/#generic-reader-mixin-definition
   8  * https://streams.spec.whatwg.org/#default-reader-class-definition
   9  */
  10
  11 typedef (ReadableStreamDefaultReader or ReadableStreamBYOBReader) ReadableStreamReader;
  12
  13 enum ReadableStreamType { "bytes" };
  14
  15 interface mixin ReadableStreamGenericReader {
  16   readonly attribute Promise<undefined> closed;
  17
  18   [NewObject]
  19   Promise<undefined> cancel(optional any reason);
  20 };
  21
  22 [Exposed=*]
  23 interface ReadableStreamDefaultReader {
  24   [Throws]
  25   constructor(ReadableStream stream);
  26
  27   [NewObject]
  28   Promise<ReadableStreamReadResult> read();
  29
  30   [Throws]
  31   undefined releaseLock();
  32 };
  33 ReadableStreamDefaultReader includes ReadableStreamGenericReader;
  34
  35
  36 dictionary ReadableStreamReadResult {
  37  any value;
  38  boolean done;
  39 };