Skip to main content
FileHandle.readableWebStream - fs/promises - Node documentation
method FileHandle.readableWebStream
Unstable

Usage in Deno

import { type FileHandle } from "node:fs/promises";
FileHandle.readableWebStream(options?: ReadableWebStreamOptions): ReadableStream

Returns a ReadableStream that may be used to read the files data.

An error will be thrown if this method is called more than once or is called after the FileHandle is closed or closing.

import {
  open,
} from 'node:fs/promises';

const file = await open('./some/file/to/read');

for await (const chunk of file.readableWebStream())
  console.log(chunk);

await file.close();

While the ReadableStream will read the file to completion, it will not close the FileHandle automatically. User code must still call thefileHandle.close() method.

Parameters

optional
options: ReadableWebStreamOptions

Return Type