ReadStream | typescript

Hierarchy

Readable
- ReadStream

Implements

ReadableStream

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ReadStream(opts?: ReadableOptions): ReadStream

Inherited from Readable.constructor

Overrides Stream.constructor
- Defined in node_modules/@types/node/stream.d.ts:40
Parameters
- Optional opts: ReadableOptions
Returns ReadStream

Properties

bytesRead

bytesRead: number

destroyed

destroyed: boolean

path

path: string | Buffer

pending

pending: boolean

readable

readable: boolean

readableEncoding

readableEncoding: BufferEncoding | null

readableEnded

readableEnded: boolean

readableFlowing

readableFlowing: boolean | null

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

readableObjectMode

readableObjectMode: boolean

Methods

[Symbol.asyncIterator]

[Symbol.asyncIterator](): AsyncIterableIterator<any>

Implementation of ReadableStream.[Symbol.asyncIterator]

Inherited from Readable.[Symbol.asyncIterator]
- Defined in node_modules/@types/node/stream.d.ts:129
Returns AsyncIterableIterator<any>

_destroy

_destroy(error: Error | null, callback: function): void

Inherited from Readable._destroy
- Defined in node_modules/@types/node/stream.d.ts:52
Parameters
- error: Error | null
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_read

_read(size: number): void

Inherited from Readable._read
- Defined in node_modules/@types/node/stream.d.ts:42
Parameters
- size: number
Returns void

addListener

addListener(event: "close", listener: function): this
addListener(event: "data", listener: function): this
addListener(event: "end", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: "open", listener: function): this
addListener(event: "pause", listener: function): this
addListener(event: "readable", listener: function): this
addListener(event: "ready", listener: function): this
addListener(event: "resume", listener: function): this
addListener(event: string | symbol, listener: function): this

Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:161
events.EventEmitter
1. open
2. close
3. ready
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:162
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:163
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:164
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:165
Parameters
- event: "open"
- listener: function
  - - (fd: number): void
    - Parameters
      - fd: number
      Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:166
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:167
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:168
Parameters
- event: "ready"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:169
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.addListener
- Defined in node_modules/@types/node/fs.d.ts:170
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

close(): void

- Defined in node_modules/@types/node/fs.d.ts:150
Returns void

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in node_modules/@types/node/stream.d.ts:53
Parameters
- Optional error: Error
Returns void

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "error", err: Error): boolean
emit(event: "pause"): boolean
emit(event: "readable"): boolean
emit(event: "resume"): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:75
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:76
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:77
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:78
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:79
Parameters
- event: "pause"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:80
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:81
Parameters
- event: "resume"
Returns boolean
Implementation of ReadableStream.emit

Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/stream.d.ts:82
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Implementation of ReadableStream.eventNames

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Implementation of ReadableStream.getMaxListeners

Inherited from EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

isPaused

isPaused(): boolean

Implementation of ReadableStream.isPaused

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/stream.d.ts:47
Returns boolean

listenerCount

listenerCount(event: string | symbol): number

Implementation of ReadableStream.listenerCount

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Implementation of ReadableStream.listeners

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "close", listener: function): this
on(event: "data", listener: function): this
on(event: "end", listener: function): this
on(event: "error", listener: function): this
on(event: "open", listener: function): this
on(event: "pause", listener: function): this
on(event: "readable", listener: function): this
on(event: "ready", listener: function): this
on(event: "resume", listener: function): this
on(event: string | symbol, listener: function): this

Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:172
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:173
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:174
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:175
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:176
Parameters
- event: "open"
- listener: function
  - - (fd: number): void
    - Parameters
      - fd: number
      Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:177
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:178
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:179
Parameters
- event: "ready"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:180
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.on
- Defined in node_modules/@types/node/fs.d.ts:181
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "close", listener: function): this
once(event: "data", listener: function): this
once(event: "end", listener: function): this
once(event: "error", listener: function): this
once(event: "open", listener: function): this
once(event: "pause", listener: function): this
once(event: "readable", listener: function): this
once(event: "ready", listener: function): this
once(event: "resume", listener: function): this
once(event: string | symbol, listener: function): this

Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:183
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:184
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:185
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:186
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:187
Parameters
- event: "open"
- listener: function
  - - (fd: number): void
    - Parameters
      - fd: number
      Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:188
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:189
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:190
Parameters
- event: "ready"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:191
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.once
- Defined in node_modules/@types/node/fs.d.ts:192
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pause

pause(): this

Implementation of ReadableStream.pause

Inherited from Readable.pause
- Defined in node_modules/@types/node/stream.d.ts:45
Returns this

pipe

pipe<T>(destination: T, options?: object): T

Inherited from internal.pipe
- Defined in node_modules/@types/node/stream.d.ts:10
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: object
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: "close", listener: function): this
prependListener(event: "data", listener: function): this
prependListener(event: "end", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: "open", listener: function): this
prependListener(event: "pause", listener: function): this
prependListener(event: "readable", listener: function): this
prependListener(event: "ready", listener: function): this
prependListener(event: "resume", listener: function): this
prependListener(event: string | symbol, listener: function): this

Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:194
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:195
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:196
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:197
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:198
Parameters
- event: "open"
- listener: function
  - - (fd: number): void
    - Parameters
      - fd: number
      Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:199
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:200
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:201
Parameters
- event: "ready"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:202
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependListener
- Defined in node_modules/@types/node/fs.d.ts:203
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "data", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: "open", listener: function): this
prependOnceListener(event: "pause", listener: function): this
prependOnceListener(event: "readable", listener: function): this
prependOnceListener(event: "ready", listener: function): this
prependOnceListener(event: "resume", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:205
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:206
Parameters
- event: "data"
- listener: function
  - - (chunk: Buffer | string): void
    - Parameters
      - chunk: Buffer | string
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:207
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:208
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:209
Parameters
- event: "open"
- listener: function
  - - (fd: number): void
    - Parameters
      - fd: number
      Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:210
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:211
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:212
Parameters
- event: "ready"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:213
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Overrides Readable.prependOnceListener
- Defined in node_modules/@types/node/fs.d.ts:214
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

push

push(chunk: any, encoding?: BufferEncoding): boolean

Inherited from Readable.push
- Defined in node_modules/@types/node/stream.d.ts:51
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns boolean

rawListeners

rawListeners(event: string | symbol): Function[]

Implementation of ReadableStream.rawListeners

Inherited from EventEmitter.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): any

Implementation of ReadableStream.read

Inherited from Readable.read
- Defined in node_modules/@types/node/stream.d.ts:43
Parameters
- Optional size: number
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): this

Implementation of ReadableStream.removeAllListeners

Inherited from EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: function): this
removeListener(event: "data", listener: function): this
removeListener(event: "end", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: "pause", listener: function): this
removeListener(event: "readable", listener: function): this
removeListener(event: "resume", listener: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:120
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:121
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:122
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:123
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:124
Parameters
- event: "pause"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:125
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:126
Parameters
- event: "resume"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/stream.d.ts:127
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): this

Implementation of ReadableStream.resume

Inherited from Readable.resume
- Defined in node_modules/@types/node/stream.d.ts:46
Returns this

setEncoding

setEncoding(encoding: BufferEncoding): this

Implementation of ReadableStream.setEncoding

Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/stream.d.ts:44
Parameters
- encoding: BufferEncoding
Returns this

setMaxListeners

setMaxListeners(n: number): this

Implementation of ReadableStream.setMaxListeners

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

unpipe

unpipe(destination?: WritableStream): this

Implementation of ReadableStream.unpipe

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/stream.d.ts:48
Parameters
- Optional destination: WritableStream
Returns this

unshift

unshift(chunk: any, encoding?: BufferEncoding): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/stream.d.ts:49
Parameters
- chunk: any
- Optional encoding: BufferEncoding
Returns void

wrap

wrap(oldStream: ReadableStream): this

Implementation of ReadableStream.wrap

Inherited from Readable.wrap
- Defined in node_modules/@types/node/stream.d.ts:50
Parameters
- oldStream: ReadableStream
Returns this

Static from

from(iterable: Iterable<any> | AsyncIterable<any>, options?: ReadableOptions): Readable

Inherited from Readable.from
- Defined in node_modules/@types/node/stream.d.ts:31
A utility method for creating Readable Streams out of iterators.

Parameters
- iterable: Iterable<any> | AsyncIterable<any>
- Optional options: ReadableOptions
Returns Readable

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: ReadableOptions

Returns ReadStream

Properties

bytesRead

destroyed

path

pending

readable

readableEncoding

readableEnded

readableFlowing

readableHighWaterMark

readableLength

readableObjectMode

Methods

[Symbol.asyncIterator]

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_read

Parameters

size: number

Returns void

addListener

Parameters

event: "close"

listener: function

Returns void

Returns this

Parameters

event: "data"

listener: function

Parameters

chunk: Buffer | string

Returns void

Returns this

Parameters

event: "end"

listener: function

Returns void

Returns this

Parameters

event: "error"

listener: function

Parameters

err: Error

Returns void

Returns this

Parameters

event: "open"

listener: function

Parameters

fd: number

Returns void

Returns this

Parameters

event: "pause"

listener: function

Returns void

Returns this

Parameters

event: "readable"

listener: function

Returns void

Returns this