foster/denoland-deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-11-25 15:29:32 -05:00
Code Issues Packages 1 Wiki Activity

Add comments in Reader/SyncReader about iter/iterSync (#4852)

Browse source
This commit is contained in:
Ryan Dahl 2020-04-22 16:00:48 -04:00 committed by GitHub
parent 68d287eed5
commit e26c2cd7c8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
cli/js/lib.deno.ns.d.ts vendored
View file

@ -446,7 +446,6 @@ declare namespace Deno {
SEEK_END = 2,
}
/** **UNSTABLE**: might make `Reader` into iterator of some sort. */
export interface Reader {
/** Reads up to `p.byteLength` bytes into `p`. It resolves to the number of
* bytes read (`0` < `n` <= `p.byteLength`) and rejects if any error
@ -465,6 +464,8 @@ declare namespace Deno {
* after reading some bytes and also both of the allowed EOF behaviors.
*
* Implementations should not retain a reference to `p`.
*
* Use Deno.iter() to turn a Reader into an AsyncIterator.
*/
read(p: Uint8Array): Promise<number | EOF>;
}
@ -487,6 +488,8 @@ declare namespace Deno {
* after reading some bytes and also both of the allowed EOF behaviors.
*
* Implementations should not retain a reference to `p`.
*
* Use Deno.iterSync() to turn a SyncReader into an Iterator.
*/
readSync(p: Uint8Array): number | EOF;
}