language-servers/deno
1
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2025-07-23 05:05:08 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

stabilize Deno.iter() and Deno.iterSync() (#4890)

Browse source
This commit is contained in:
Bartek Iwańczuk 2020-04-25 00:05:48 +02:00 • committed by GitHub
parent 824329f0da
commit e9fa6b87ce
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 46 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -576,60 +576,68 @@ declare namespace Deno {
*/
export function copy(dst: Writer, src: Reader): Promise<number>;
/** **UNSTABLE**: new API, yet to be vetted
* Turns a Reader, `r`, into an async iterator.
/** Turns a Reader, `r`, into an async iterator.
*
* let f = await open("/etc/passwd");
* for await (const chunk of iter(f)) {
* let f = await Deno.open("/etc/passwd");
* for await (const chunk of Deno.iter(f)) {
* console.log(chunk);
* }
* f.close();
*
* Second argument can be used to tune size of a buffer.
* Default size of the buffer is 1024 bytes.
* Default size of the buffer is 32kB.
*
* let f = await open("/etc/passwd");
* for await (const chunk of iter(f, 1024 * 1024)) {
* let f = await Deno.open("/etc/passwd");
* const iter = Deno.iter(f, {
* bufSize: 1024 * 1024
* });
* for await (const chunk of iter) {
* console.log(chunk);
* }
* f.close();
*
* Iterator uses internal buffer of fixed size for efficiency returning
* a view on that buffer on each iteration. It it therefore callers
* responsibility to copy contents of the buffer if needed; otherwise
* Iterator uses an internal buffer of fixed size for efficiency; it returns
* a view on that buffer on each iteration. It is therefore caller's
* responsibility to copy contents of the buffer if needed; otherwise the
* next iteration will overwrite contents of previously returned chunk.
*/
export function iter(
r: Reader,
bufSize?: number
options?: {
bufSize?: number;
}
): AsyncIterableIterator<Uint8Array>;
/** **UNSTABLE**: new API, yet to be vetted
* Turns a SyncReader, `r`, into an iterator.
/** Turns a SyncReader, `r`, into an iterator.
*
* let f = openSync("/etc/passwd");
* for (const chunk of iterSync(reader)) {
* let f = Deno.openSync("/etc/passwd");
* for (const chunk of Deno.iterSync(reader)) {
* console.log(chunk);
* }
* f.close();
*
* Second argument can be used to tune size of a buffer.
* Default size of the buffer is 1024 bytes.
* Default size of the buffer is 32kB.
*
* let f = openSync("/etc/passwd");
* for (const chunk of iterSync(reader, 1024 * 1024)) {
* let f = await Deno.open("/etc/passwd");
* const iter = Deno.iterSync(f, {
* bufSize: 1024 * 1024
* });
* for (const chunk of iter) {
* console.log(chunk);
* }
* f.close()
* f.close();
*
* Iterator uses internal buffer of fixed size for efficiency returning
* a view on that buffer on each iteration. It it therefore callers
* responsibility to copy contents of the buffer if needed; otherwise
* Iterator uses an internal buffer of fixed size for efficiency; it returns
* a view on that buffer on each iteration. It is therefore caller's
* responsibility to copy contents of the buffer if needed; otherwise the
* next iteration will overwrite contents of previously returned chunk.
*/
export function iterSync(
r: SyncReader,
bufSize?: number
options?: {
bufSize?: number;
}
): IterableIterator<Uint8Array>;
/** Synchronously open a file and return an instance of `Deno.File`. The