gecko-dev/dom/webidl/ReadableStreamDefaultReader.webidl

40 lines
1.1 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/.
*
* The origin of this IDL file is
* https://streams.spec.whatwg.org/#generic-reader-mixin-definition
* https://streams.spec.whatwg.org/#default-reader-class-definition
*/
typedef (ReadableStreamDefaultReader or ReadableStreamBYOBReader) ReadableStreamReader;
enum ReadableStreamType { "bytes" };
interface mixin ReadableStreamGenericReader {
readonly attribute Promise<undefined> closed;
[NewObject]
Promise<undefined> cancel(optional any reason);
};
[Exposed=*]
interface ReadableStreamDefaultReader {
[Throws]
constructor(ReadableStream stream);
[NewObject]
Promise<ReadableStreamReadResult> read();
[Throws]
undefined releaseLock();
};
ReadableStreamDefaultReader includes ReadableStreamGenericReader;
dictionary ReadableStreamReadResult {
any value;
boolean done;
};