Skip to main content
Deno 2 is finally here 🎉️
Learn more
Go to Latest
The Standard Library has been moved to JSR. See the blog post for details.
function iterateReaderSync
Deprecated
Deprecated

(will be removed in 1.0.0) Import from https://deno.land/std/io/iterate_reader.ts instead.

import { iterateReaderSync } from "https://deno.land/std@0.220.0/streams/mod.ts";

Turns a ReaderSync, r, into an iterator.

import { iterateReaderSync } from "https://deno.land/std@0.220.0/streams/iterate_reader.ts";

using f = Deno.openSync("/etc/passwd");
for (const chunk of iterateReaderSync(f)) {
  console.log(chunk);
}

Second argument can be used to tune size of a buffer. Default size of the buffer is 32kB.

import { iterateReaderSync } from "https://deno.land/std@0.220.0/streams/iterate_reader.ts";

using f = await Deno.open("/etc/passwd");
const iter = iterateReaderSync(f, {
  bufSize: 1024 * 1024
});
for (const chunk of iter) {
  console.log(chunk);
}

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.

Parameters

optional
options: { bufSize?: number; }

Returns

IterableIterator<Uint8Array>