Skip to main content
function Deno.iterSync
Deprecated
Deprecated

Use iterateReaderSync from https://deno.land/std/streams/conversion.ts instead. Deno.iterSync will be removed in Deno 2.0.

Turns a ReaderSync, r, into an iterator.

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

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

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();

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>