Skip to main content

@std/streams@0.215.0

latest
Works with
It is unknown whether this package works with Node.js, Deno, Browsers, Cloudflare Workers, Bun
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
JSR Score70%
Published2 years ago (0.215.0)
function iterateReaderSync
iterateReaderSync(
r: ReaderSync,
options?: { bufSize?: number; }
): IterableIterator<Uint8Array>
Deprecated

(will be removed after 1.0.0) Use ReadableStream instead.

Turns a ReaderSync, r, into an iterator.

import { iterateReaderSync } from "@std/streams/iterate_reader";

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 "@std/streams/iterate_reader";

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

r: ReaderSync
optional
options: { bufSize?: number; }

Return Type

IterableIterator<Uint8Array>

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/streams

Import symbol

import { iterateReaderSync } from "@std/streams";
or

Import directly with a jsr specifier

import { iterateReaderSync } from "jsr:@std/streams";