ReadStream

Defined in: src/node/streams.ts:19

A ReadStream implementation that wraps an underlying global ReadableStream.

Extends

• Readable

Implements

• ReadStream

Constructors

Constructor

new ReadStream(opts?, handleOrPromise): ReadStream

Defined in: src/node/streams.ts:26

Parameters

opts?

CreateReadStreamOptions = {}

handleOrPromise

FileHandle | Promise<FileHandle>

Returns

ReadStream

Overrides

Readable.constructor

Properties

_events

_events: Listeners

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:28

Inherited from

Readable._events

---

_eventsCount

_eventsCount: number

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:29

Inherited from

Readable._eventsCount

---

_maxListeners?

optional _maxListeners?: number

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:30

Inherited from

Readable._maxListeners

---

_readableState

_readableState: ReadableState

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:99

Inherited from

Readable._readableState

---

_writableState?

optional _writableState?: WritableState

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:101

Present on a Duplex; undefined on a plain Readable.

Inherited from

Readable._writableState

---

[kCapture]

protected [kCapture]: boolean

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:31

Inherited from

Readable.[kCapture]

---

pending

pending: boolean = true

Defined in: src/node/streams.ts:20

This property is true if the underlying file has not been opened yet, i.e. before the 'ready' event is emitted.

Since

v11.2.0, v10.16.0

Implementation of

fs.ReadStream.pending

---

_fromList

static _fromList: (n, state) => any

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:163

Exposed for tests.

Takes n bytes (or one object) off the front of the buffer.

Parameters

n

number

state

ReadableState

Returns

any

Inherited from

Readable._fromList

---

captureRejections

static captureRejections: boolean

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:25

The default for the captureRejections option of newly created emitters.

Inherited from

Readable.captureRejections

---

captureRejectionSymbol

readonly static captureRejectionSymbol: typeof captureRejectionSymbol

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:26

Inherited from

Readable.captureRejectionSymbol

---

defaultMaxListeners

static defaultMaxListeners: number

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:23

Inherited from

Readable.defaultMaxListeners

---

errorMonitor

readonly static errorMonitor: typeof errorMonitor

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:27

Inherited from

Readable.errorMonitor

---

ReadableState

readonly static ReadableState: typeof ReadableState

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:161

Inherited from

Readable.ReadableState

Accessors

bytesRead

Get Signature

get bytesRead(): number

Defined in: src/node/streams.ts:77

The number of bytes that have been read so far.

Since

v6.4.0

Returns

number

Implementation of

fs.ReadStream.bytesRead

---

closed

Get Signature

get closed(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:149

Is true after 'close' has been emitted.

Since

v18.0.0

Returns

boolean

Implementation of

fs.ReadStream.closed

Inherited from

Readable.closed

---

destroyed

Get Signature

get destroyed(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:150

Is true after readable.destroy() has been called.

Since

v8.0.0

Returns

boolean

Set Signature

set destroyed(value): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:151

Is true after readable.destroy() has been called.

Since

v8.0.0

Parameters

value

boolean

Returns

void

Implementation of

fs.ReadStream.destroyed

Inherited from

Readable.destroyed

---

errored

Get Signature

get errored(): Error | null

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:148

Returns error if the stream has been destroyed with an error.

Since

v18.0.0

Returns

Error | null

Implementation of

fs.ReadStream.errored

Inherited from

Readable.errored

---

path

Get Signature

get path(): string

Defined in: src/node/streams.ts:73

The path to the file the stream is reading from as specified in the first argument to fs.createReadStream(). If path is passed as a string, thenreadStream.path will be a string. If path is passed as a Buffer, thenreadStream.path will be a Buffer. If fd is specified, thenreadStream.path will be undefined.

Since

v0.1.93

Returns

string

Implementation of

fs.ReadStream.path

---

readable

Get Signature

get readable(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:137

Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

Since

v11.4.0

Returns

boolean

Set Signature

set readable(value): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:138

Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

Since

v11.4.0

Parameters

value

boolean

Returns

void

Implementation of

fs.ReadStream.readable

Inherited from

Readable.readable

---

readableAborted

Get Signature

get readableAborted(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:140

Returns whether the stream was destroyed or errored before emitting 'end'.

Since

v16.8.0

Returns

boolean

Implementation of

fs.ReadStream.readableAborted

Inherited from

Readable.readableAborted

---

readableBuffer

Get Signature

get readableBuffer(): any[] | undefined

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:142

Returns

any[] | undefined

Inherited from

Readable.readableBuffer

---

readableDidRead

Get Signature

get readableDidRead(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:139

Returns whether 'data' has been emitted.

Since

v16.7.0, v14.18.0

Returns

boolean

Implementation of

fs.ReadStream.readableDidRead

Inherited from

Readable.readableDidRead

---

readableEncoding

Get Signature

get readableEncoding(): BufferEncoding | null

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:147

Getter for the property encoding of a given Readable stream. The encoding property can be set using the setEncoding method.

Since

v12.7.0

Returns

BufferEncoding | null

Implementation of

fs.ReadStream.readableEncoding

Inherited from

Readable.readableEncoding

---

readableEnded

Get Signature

get readableEnded(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:152

Becomes true when 'end' event is emitted.

Since

v12.9.0

Returns

boolean

Implementation of

fs.ReadStream.readableEnded

Inherited from

Readable.readableEnded

---

readableFlowing

Get Signature

get readableFlowing(): boolean | null

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:143

This property reflects the current state of a Readable stream as described in the Three states section.

Since

v9.4.0

Returns

boolean | null

Set Signature

set readableFlowing(value): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:144

This property reflects the current state of a Readable stream as described in the Three states section.

Since

v9.4.0

Parameters

value

boolean | null

Returns

void

Implementation of

fs.ReadStream.readableFlowing

Inherited from

Readable.readableFlowing

---

readableHighWaterMark

Get Signature

get readableHighWaterMark(): number

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:141

Returns the value of highWaterMark passed when creating this Readable.

Since

v9.3.0

Returns

number

Implementation of

fs.ReadStream.readableHighWaterMark

Inherited from

Readable.readableHighWaterMark

---

readableLength

Get Signature

get readableLength(): number

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:145

This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the highWaterMark.

Since

v9.4.0

Returns

number

Implementation of

fs.ReadStream.readableLength

Inherited from

Readable.readableLength

---

readableObjectMode

Get Signature

get readableObjectMode(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:146

Getter for the property objectMode of a given Readable stream.

Since

v12.3.0

Returns

boolean

Implementation of

fs.ReadStream.readableObjectMode

Inherited from

Readable.readableObjectMode

Methods

_construct()?

optional _construct(callback): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:106

Parameters

callback

Callback

Returns

void

Implementation of

fs.ReadStream._construct

Inherited from

Readable._construct

---

_destroy()

_destroy(error, callback): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:105

Parameters

error

Error | null

callback

Callback

Returns

void

Implementation of

fs.ReadStream._destroy

Inherited from

Readable._destroy

---

_read()

_read(): Promise<void>

Defined in: src/node/streams.ts:47

Returns

Promise<void>

Implementation of

fs.ReadStream._read

Overrides

Readable._read

---

_undestroy()

_undestroy(): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:104

Returns

void

Inherited from

Readable._undestroy

---

[asyncDispose]()

[asyncDispose](): Promise<void>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:108

Returns

Promise<void>

Implementation of

fs.ReadStream.[asyncDispose]

Inherited from

Readable.[asyncDispose]

---

[asyncIterator]()

[asyncIterator](): AsyncIterator<any>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:135

Returns

AsyncIterator<any>

Implementation of

fs.ReadStream.[asyncIterator]

Inherited from

Readable.[asyncIterator]

---

[captureRejectionSymbol]()

[captureRejectionSymbol](err): void

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:107

Parameters

err

Error

Returns

void

Inherited from

Readable.[captureRejectionSymbol]

---

[toAsyncStreamable]()

[toAsyncStreamable](): AsyncGenerator<Uint8Array<ArrayBufferLike>[], any, any>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:164

Returns

AsyncGenerator<Uint8Array<ArrayBufferLike>[], any, any>

Implementation of

fs.ReadStream.[toAsyncStreamable]

Inherited from

Readable.[toAsyncStreamable]

---

addListener()

addListener(ev, fn): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:126

Parameters

ev

EventKey

fn

Listener

Returns

this

Implementation of

fs.ReadStream.addListener

Inherited from

Readable.addListener

---

close()

close(callback?): void

Defined in: src/node/streams.ts:68

Like Node, the callback is invoked once the stream is closed. Closing before the stream has finished reports ERR_STREAM_PREMATURE_CLOSE.

Parameters

callback?

Callback<[void]> = ...

Returns

void

Implementation of

fs.ReadStream.close

---

compose()

compose(stream, options?): Duplex

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:199

Available once @zenfs/streams (or @zenfs/streams/compose) has been imported.

Parameters

stream

any

options?

signal?

AbortSignal

Returns

Duplex

Implementation of

fs.ReadStream.compose

Inherited from

Readable.compose

---

destroy()

destroy(error?, callback?): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:103

Parameters

error?

Error | null

callback?

Callback

Returns

this

Implementation of

fs.ReadStream.destroy

Inherited from

Readable.destroy

---

drop()

drop(limit, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:180

Parameters

limit

number

options?

ReadableOperatorOptions

Returns

Readable

Implementation of

fs.ReadStream.drop

Inherited from

Readable.drop

---

emit()

emit(type, …args): boolean

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:35

Parameters

type

EventKey

args

…any[]

Returns

boolean

Implementation of

fs.ReadStream.emit

Inherited from

Readable.emit

---

eventNames()

eventNames(): EventKey[]

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:47

Returns

EventKey[]

Implementation of

fs.ReadStream.eventNames

Inherited from

Readable.eventNames

---

every()

every(fn, options?): Promise<boolean>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:182

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Promise<boolean>

Implementation of

fs.ReadStream.every

Inherited from

Readable.every

---

filter()

filter(fn, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:174

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Readable

Implementation of

fs.ReadStream.filter

Inherited from

Readable.filter

---

find()

find(fn, options?): Promise<any>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:188

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Promise<any>

Implementation of

fs.ReadStream.find

Inherited from

Readable.find

---

flatMap()

flatMap(fn, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:177

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Readable

Implementation of

fs.ReadStream.flatMap

Inherited from

Readable.flatMap

---

forEach()

forEach(fn, options?): Promise<void>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:191

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Promise<void>

Implementation of

fs.ReadStream.forEach

Inherited from

Readable.forEach

---

getMaxListeners()

getMaxListeners(): number

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:34

Returns

number

Implementation of

fs.ReadStream.getMaxListeners

Inherited from

Readable.getMaxListeners

---

isPaused()

isPaused(): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:116

The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

const readable = new stream.Readable();

readable.isPaused(); // === false
readable.pause();
readable.isPaused(); // === true
readable.resume();
readable.isPaused(); // === false

Returns

boolean

Since

v0.11.14

Implementation of

fs.ReadStream.isPaused

Inherited from

Readable.isPaused

---

iterator()

iterator(options?): AsyncIterator<any>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:136

The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

Parameters

options?

ReadableIteratorOptions

Returns

AsyncIterator<any>

Since

v16.3.0

Implementation of

fs.ReadStream.iterator

Inherited from

Readable.iterator

---

listenerCount()

listenerCount(type, listener?): number

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:46

Parameters

type

EventKey

listener?

Listener

Returns

number

Implementation of

fs.ReadStream.listenerCount

Inherited from

Readable.listenerCount

---

listeners()

listeners(type): Listener[]

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:44

Parameters

type

EventKey

Returns

Listener[]

Implementation of

fs.ReadStream.listeners

Inherited from

Readable.listeners

---

map()

map(fn, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:171

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Readable

Implementation of

fs.ReadStream.map

Inherited from

Readable.map

---

off()

off(ev, fn): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:128

Parameters

ev

EventKey

fn

Listener

Returns

this

Implementation of

fs.ReadStream.off

Inherited from

Readable.off

---

on()

on(ev, fn): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:125

Parameters

ev

EventKey

fn

Listener

Returns

this

Implementation of

fs.ReadStream.on

Inherited from

Readable.on

---

once()

once(type, listener): this

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:39

Parameters

type

EventKey

listener

Listener

Returns

this

Implementation of

fs.ReadStream.once

Inherited from

Readable.once

---

pause()

pause(): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:132

The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

const readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log(`Received ${chunk.length} bytes of data.`);
  readable.pause();
  console.log('There will be no additional data for 1 second.');
  setTimeout(() => {
    console.log('Now data will start flowing again.');
    readable.resume();
  }, 1000);
});

The readable.pause() method has no effect if there is a 'readable' event listener.

Returns

this

Since

v0.9.4

Implementation of

fs.ReadStream.pause

Inherited from

Readable.pause

---

pipe()

pipe<T>(dest, pipeOpts?): T

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:121

Type Parameters

T

T extends PipeDestination

Parameters

dest

T

pipeOpts?

end?

boolean

Returns

T

Implementation of

fs.ReadStream.pipe

Inherited from

Readable.pipe

---

prependListener()

prependListener(type, listener): this

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:38

Parameters

type

EventKey

listener

Listener

Returns

this

Implementation of

fs.ReadStream.prependListener

Inherited from

Readable.prependListener

---

prependOnceListener()

prependOnceListener(type, listener): this

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:40

Parameters

type

EventKey

listener

Listener

Returns

this

Implementation of

fs.ReadStream.prependOnceListener

Inherited from

Readable.prependOnceListener

---

push()

push(chunk, encoding?): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:113

Adds a chunk to the read buffer, or ends the stream when passed null. Returns false once the high water mark is reached.

Parameters

chunk

any

encoding?

BufferEncoding

Returns

boolean

Implementation of

fs.ReadStream.push

Inherited from

Readable.push

---

rawListeners()

rawListeners(type): Listener[]

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:45

Parameters

type

EventKey

Returns

Listener[]

Implementation of

fs.ReadStream.rawListeners

Inherited from

Readable.rawListeners

---

read()

read(n?): any

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:119

The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating in object mode.

The optional size argument specifies a specific number of bytes to read. If size bytes are not available to be read, null will be returned unless the stream has ended, in which case all of the data remaining in the internal buffer will be returned.

If the size argument is not specified, all of the data contained in the internal buffer will be returned.

The size argument must be less than or equal to 1 GiB.

The readable.read() method should only be called on Readable streams operating in paused mode. In flowing mode, readable.read() is called automatically until the internal buffer is fully drained.

const readable = getReadableStreamSomehow();

// 'readable' may be triggered multiple times as data is buffered in
readable.on('readable', () => {
  let chunk;
  console.log('Stream is readable (new data received in buffer)');
  // Use a loop to make sure we read all currently available data
  while (null !== (chunk = readable.read())) {
    console.log(`Read ${chunk.length} bytes of data...`);
  }
});

// 'end' will be triggered once when there is no more data available
readable.on('end', () => {
  console.log('Reached end of stream.');
});

Each call to readable.read() returns a chunk of data, or null. The chunks are not concatenated. A while loop is necessary to consume all data currently in the buffer. When reading a large file .read() may return null, having consumed all buffered content so far, but there is still more data to come not yet buffered. In this case a new 'readable' event will be emitted when there is more data in the buffer. Finally the 'end' event will be emitted when there is no more data to come.

Therefore to read a file’s whole contents from a readable, it is necessary to collect chunks across multiple 'readable' events:

const chunks = [];

readable.on('readable', () => {
  let chunk;
  while (null !== (chunk = readable.read())) {
    chunks.push(chunk);
  }
});

readable.on('end', () => {
  const content = chunks.join('');
});

A Readable stream in object mode will always return a single item from a call to readable.read(size), regardless of the value of the size argument.

If the readable.read() method returns a chunk of data, a 'data' event will also be emitted.

Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

Parameters

n?

number | null

Returns

any

Since

v0.9.4

Implementation of

fs.ReadStream.read

Inherited from

Readable.read

---

reduce()

reduce(reducer, initialValue?, options?): Promise<any>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:195

Parameters

reducer

(previous, value, options) => any

initialValue?

any

options?

ReadableOperatorOptions

Returns

Promise<any>

Implementation of

fs.ReadStream.reduce

Inherited from

Readable.reduce

---

removeAllListeners()

removeAllListeners(ev?): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:129

Parameters

ev?

EventKey

Returns

this

Implementation of

fs.ReadStream.removeAllListeners

Inherited from

Readable.removeAllListeners

---

removeListener()

removeListener(ev, fn): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:127

Parameters

ev

EventKey

fn

Listener

Returns

this

Implementation of

fs.ReadStream.removeListener

Inherited from

Readable.removeListener

---

resume()

resume(): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:131

Switches the stream into flowing mode.

Returns

this

Implementation of

fs.ReadStream.resume

Inherited from

Readable.resume

---

setEncoding()

setEncoding(encoding): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:118

Makes the stream emit strings in encoding rather than Buffers, without splitting characters.

Parameters

encoding

BufferEncoding

Returns

this

Implementation of

fs.ReadStream.setEncoding

Inherited from

Readable.setEncoding

---

setMaxListeners()

setMaxListeners(n): this

Defined in: node_modules/@zenfs/streams/dist/events.d.ts:33

Parameters

n

number

Returns

this

Implementation of

fs.ReadStream.setMaxListeners

Inherited from

Readable.setMaxListeners

---

some()

some(fn, options?): Promise<boolean>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:185

Parameters

fn

(value, options) => any

options?

ReadableOperatorOptions

Returns

Promise<boolean>

Implementation of

fs.ReadStream.some

Inherited from

Readable.some

---

take()

take(limit, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:181

Parameters

limit

number

options?

ReadableOperatorOptions

Returns

Readable

Implementation of

fs.ReadStream.take

Inherited from

Readable.take

---

toArray()

toArray(options?): Promise<any[]>

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:194

Parameters

options?

ReadableOperatorOptions

Returns

Promise<any[]>

Implementation of

fs.ReadStream.toArray

Inherited from

Readable.toArray

---

unpipe()

unpipe(dest?): this

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:124

The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

If the destination is not specified, then all pipes are detached.

If the destination is specified, but no pipe is set up for it, then the method does nothing.

import fs from 'node:fs';
const readable = getReadableStreamSomehow();
const writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second.
readable.pipe(writable);
setTimeout(() => {
  console.log('Stop writing to file.txt.');
  readable.unpipe(writable);
  console.log('Manually close the file stream.');
  writable.end();
}, 1000);

Parameters

dest?

PipeDestination

Returns

this

Since

v0.9.4

Implementation of

fs.ReadStream.unpipe

Inherited from

Readable.unpipe

---

unshift()

unshift(chunk, encoding?): boolean

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:115

Returns a chunk to the front of the read buffer. Should only ever be a chunk that came out of read().

Parameters

chunk

any

encoding?

BufferEncoding

Returns

boolean

Implementation of

fs.ReadStream.unshift

Inherited from

Readable.unshift

---

wrap()

wrap(oldStream): this

Defined in: src/node/streams.ts:81

Uses an old-style (pre-streams2) stream as this stream’s data source.

Parameters

oldStream

ReadableStream

Returns

this

Implementation of

fs.ReadStream.wrap

Overrides

Readable.wrap

---

from()

static from(iterable, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:154

Builds a Readable from an iterable, async iterable, string or Buffer.

Parameters

iterable

string | Buffer<ArrayBufferLike> | Iterable<unknown, any, any> | AsyncIterable<unknown, any, any>

options?

ReadableOptions<Readable>

Returns

Readable

Inherited from

Readable.from

---

fromWeb()

static fromWeb(readableStream, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:158

Wraps a WHATWG ReadableStream.

Parameters

readableStream

ReadableStream

options?

ReadableOptions<Readable>

Returns

Readable

Inherited from

Readable.fromWeb

---

toWeb()

static toWeb(streamReadable, options?): ReadableStream

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:160

Exposes this stream as a WHATWG ReadableStream.

Parameters

streamReadable

Readable

options?

ReadableToWebOptions

Returns

ReadableStream

Inherited from

Readable.toWeb

---

wrap()

static wrap(src, options?): Readable

Defined in: node_modules/@zenfs/streams/dist/readable.d.ts:156

Wraps an old-style stream, or any object with a compatible data/end event surface.

Parameters

src

any

options?

ReadableOptions<Readable>

Returns

Readable

Inherited from

Readable.wrap