From e26c2cd7c8d1bb1799ee6a1a850b8b5fc5e1ed83 Mon Sep 17 00:00:00 2001 From: Ryan Dahl Date: Wed, 22 Apr 2020 16:00:48 -0400 Subject: Add comments in Reader/SyncReader about iter/iterSync (#4852) --- cli/js/lib.deno.ns.d.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/cli/js/lib.deno.ns.d.ts b/cli/js/lib.deno.ns.d.ts index ed2e40f84..da9a0ec93 100644 --- a/cli/js/lib.deno.ns.d.ts +++ b/cli/js/lib.deno.ns.d.ts @@ -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; } @@ -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; } -- cgit v1.2.3