fs.readstream
@listenai/lisa_core / Exports / fs / ReadStream
Class: ReadStream
fs.ReadStream
#
HierarchyReadable
↳
ReadStream
#
Table of contents#
Constructors#
Properties- bytesRead
- destroyed
- path
- pending
- readable
- readableEncoding
- readableEnded
- readableFlowing
- readableHighWaterMark
- readableLength
- readableObjectMode
- captureRejectionSymbol
- captureRejections
- defaultMaxListeners
- errorMonitor
#
Methods- [Symbol.asyncIterator]
- _destroy
- _read
- addListener
- close
- destroy
- emit
- eventNames
- getMaxListeners
- isPaused
- listenerCount
- listeners
- off
- on
- once
- pause
- pipe
- prependListener
- prependOnceListener
- push
- rawListeners
- read
- removeAllListeners
- removeListener
- resume
- setEncoding
- setMaxListeners
- unpipe
- unshift
- wrap
- from
- listenerCount
- on
- once
#
Constructors#
constructor• new ReadStream(opts?
)
#
ParametersName | Type |
---|---|
opts? | ReadableOptions |
#
Inherited fromstream.Readable.constructor
#
Defined innode_modules/@types/node/stream.d.ts:40
#
Properties#
bytesRead• bytesRead: number
#
Defined innode_modules/@types/node/fs.d.ts:151
#
destroyed• destroyed: boolean
#
Inherited fromstream.Readable.destroyed
#
Defined innode_modules/@types/node/stream.d.ts:40
#
path• path: string
| Buffer
#
Defined innode_modules/@types/node/fs.d.ts:152
#
pending• pending: boolean
#
Defined innode_modules/@types/node/fs.d.ts:153
#
readable• readable: boolean
#
Inherited fromstream.Readable.readable
#
Defined innode_modules/@types/node/stream.d.ts:33
#
readableEncoding• Readonly
readableEncoding: null
| BufferEncoding
#
Inherited fromstream.Readable.readableEncoding
#
Defined innode_modules/@types/node/stream.d.ts:34
#
readableEnded• Readonly
readableEnded: boolean
#
Inherited fromstream.Readable.readableEnded
#
Defined innode_modules/@types/node/stream.d.ts:35
#
readableFlowing• Readonly
readableFlowing: null
| boolean
#
Inherited fromstream.Readable.readableFlowing
#
Defined innode_modules/@types/node/stream.d.ts:36
#
readableHighWaterMark• Readonly
readableHighWaterMark: number
#
Inherited fromstream.Readable.readableHighWaterMark
#
Defined innode_modules/@types/node/stream.d.ts:37
#
readableLength• Readonly
readableLength: number
#
Inherited fromstream.Readable.readableLength
#
Defined innode_modules/@types/node/stream.d.ts:38
#
readableObjectMode• Readonly
readableObjectMode: boolean
#
Inherited fromstream.Readable.readableObjectMode
#
Defined innode_modules/@types/node/stream.d.ts:39
#
captureRejectionSymbol▪ Static
Readonly
captureRejectionSymbol: typeof captureRejectionSymbol
#
Inherited fromstream.Readable.captureRejectionSymbol
#
Defined innode_modules/@types/node/events.d.ts:43
#
captureRejections▪ Static
captureRejections: boolean
Sets or gets the default captureRejection value for all emitters.
#
Inherited fromstream.Readable.captureRejections
#
Defined innode_modules/@types/node/events.d.ts:49
#
defaultMaxListeners▪ Static
defaultMaxListeners: number
#
Inherited fromstream.Readable.defaultMaxListeners
#
Defined innode_modules/@types/node/events.d.ts:50
#
errorMonitor▪ Static
Readonly
errorMonitor: typeof errorMonitor
This symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error'
listeners are called.
Installing a listener using this symbol does not change the behavior once an
'error'
event is emitted, therefore the process will still crash if no
regular 'error'
listener is installed.
#
Inherited fromstream.Readable.errorMonitor
#
Defined innode_modules/@types/node/events.d.ts:42
#
Methods#
[Symbol.asyncIterator]▸ [Symbol.asyncIterator](): AsyncIterableIterator
<any
>
#
ReturnsAsyncIterableIterator
<any
>
#
Inherited fromstream.Readable.__@asyncIterator
#
Defined innode_modules/@types/node/stream.d.ts:129
#
_destroy▸ _destroy(error
, callback
): void
#
ParametersName | Type |
---|---|
error | null | Error |
callback | (error? : null | Error ) => void |
#
Returnsvoid
#
Inherited fromstream.Readable._destroy
#
Defined innode_modules/@types/node/stream.d.ts:52
#
_read▸ _read(size
): void
#
ParametersName | Type |
---|---|
size | number |
#
Returnsvoid
#
Inherited fromstream.Readable._read
#
Defined innode_modules/@types/node/stream.d.ts:42
#
addListener▸ addListener(event
, listener
): ReadStream
events.EventEmitter
- open
- close
- ready
#
ParametersName | Type |
---|---|
event | "close" |
listener | () => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:161
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "data" |
listener | (chunk : string | Buffer ) => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:162
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "end" |
listener | () => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:163
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:164
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "open" |
listener | (fd : number ) => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:165
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "pause" |
listener | () => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:166
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "readable" |
listener | () => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:167
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "ready" |
listener | () => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:168
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "resume" |
listener | () => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:169
▸ addListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Overridesstream.Readable.addListener
#
Defined innode_modules/@types/node/fs.d.ts:170
#
close▸ close(): void
#
Returnsvoid
#
Defined innode_modules/@types/node/fs.d.ts:150
#
destroy▸ destroy(error?
): void
#
ParametersName | Type |
---|---|
error? | Error |
#
Returnsvoid
#
Inherited fromstream.Readable.destroy
#
Defined innode_modules/@types/node/stream.d.ts:53
#
emit▸ emit(event
): boolean
#
ParametersName | Type |
---|---|
event | "close" |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:75
▸ emit(event
, chunk
): boolean
#
ParametersName | Type |
---|---|
event | "data" |
chunk | any |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:76
▸ emit(event
): boolean
#
ParametersName | Type |
---|---|
event | "end" |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:77
▸ emit(event
, err
): boolean
#
ParametersName | Type |
---|---|
event | "error" |
err | Error |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:78
▸ emit(event
): boolean
#
ParametersName | Type |
---|---|
event | "pause" |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:79
▸ emit(event
): boolean
#
ParametersName | Type |
---|---|
event | "readable" |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:80
▸ emit(event
): boolean
#
ParametersName | Type |
---|---|
event | "resume" |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:81
▸ emit(event
, ...args
): boolean
#
ParametersName | Type |
---|---|
event | string | symbol |
...args | any [] |
#
Returnsboolean
#
Inherited fromstream.Readable.emit
#
Defined innode_modules/@types/node/stream.d.ts:82
#
eventNames▸ eventNames(): (string
| symbol
)[]
#
Returns(string
| symbol
)[]
#
Inherited fromstream.Readable.eventNames
#
Defined innode_modules/@types/node/events.d.ts:77
#
getMaxListeners▸ getMaxListeners(): number
#
Returnsnumber
#
Inherited fromstream.Readable.getMaxListeners
#
Defined innode_modules/@types/node/events.d.ts:69
#
isPaused▸ isPaused(): boolean
#
Returnsboolean
#
Inherited fromstream.Readable.isPaused
#
Defined innode_modules/@types/node/stream.d.ts:47
#
listenerCount▸ listenerCount(event
): number
#
ParametersName | Type |
---|---|
event | string | symbol |
#
Returnsnumber
#
Inherited fromstream.Readable.listenerCount
#
Defined innode_modules/@types/node/events.d.ts:73
#
listeners▸ listeners(event
): Function
[]
#
ParametersName | Type |
---|---|
event | string | symbol |
#
ReturnsFunction
[]
#
Inherited fromstream.Readable.listeners
#
Defined innode_modules/@types/node/events.d.ts:70
#
off▸ off(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Inherited fromstream.Readable.off
#
Defined innode_modules/@types/node/events.d.ts:66
#
on▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "close" |
listener | () => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:172
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "data" |
listener | (chunk : string | Buffer ) => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:173
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "end" |
listener | () => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:174
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:175
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "open" |
listener | (fd : number ) => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:176
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "pause" |
listener | () => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:177
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "readable" |
listener | () => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:178
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "ready" |
listener | () => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:179
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "resume" |
listener | () => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:180
▸ on(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Overridesstream.Readable.on
#
Defined innode_modules/@types/node/fs.d.ts:181
#
once▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "close" |
listener | () => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:183
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "data" |
listener | (chunk : string | Buffer ) => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:184
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "end" |
listener | () => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:185
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:186
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "open" |
listener | (fd : number ) => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:187
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "pause" |
listener | () => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:188
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "readable" |
listener | () => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:189
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "ready" |
listener | () => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:190
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "resume" |
listener | () => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:191
▸ once(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Overridesstream.Readable.once
#
Defined innode_modules/@types/node/fs.d.ts:192
#
pause▸ pause(): ReadStream
#
Returns#
Inherited fromstream.Readable.pause
#
Defined innode_modules/@types/node/stream.d.ts:45
#
pipe▸ pipe<T
>(destination
, options?
): T
#
Type parametersName | Type |
---|---|
T | extends WritableStream <T > |
#
ParametersName | Type |
---|---|
destination | T |
options? | Object |
options.end? | boolean |
#
ReturnsT
#
Inherited fromstream.Readable.pipe
#
Defined innode_modules/@types/node/stream.d.ts:10
#
prependListener▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "close" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:194
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "data" |
listener | (chunk : string | Buffer ) => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:195
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "end" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:196
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:197
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "open" |
listener | (fd : number ) => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:198
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "pause" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:199
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "readable" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:200
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "ready" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:201
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "resume" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:202
▸ prependListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Overridesstream.Readable.prependListener
#
Defined innode_modules/@types/node/fs.d.ts:203
#
prependOnceListener▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "close" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:205
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "data" |
listener | (chunk : string | Buffer ) => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:206
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "end" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:207
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:208
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "open" |
listener | (fd : number ) => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:209
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "pause" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:210
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "readable" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:211
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "ready" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:212
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "resume" |
listener | () => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:213
▸ prependOnceListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Overridesstream.Readable.prependOnceListener
#
Defined innode_modules/@types/node/fs.d.ts:214
#
push▸ push(chunk
, encoding?
): boolean
#
ParametersName | Type |
---|---|
chunk | any |
encoding? | BufferEncoding |
#
Returnsboolean
#
Inherited fromstream.Readable.push
#
Defined innode_modules/@types/node/stream.d.ts:51
#
rawListeners▸ rawListeners(event
): Function
[]
#
ParametersName | Type |
---|---|
event | string | symbol |
#
ReturnsFunction
[]
#
Inherited fromstream.Readable.rawListeners
#
Defined innode_modules/@types/node/events.d.ts:71
#
read▸ read(size?
): any
#
ParametersName | Type |
---|---|
size? | number |
#
Returnsany
#
Inherited fromstream.Readable.read
#
Defined innode_modules/@types/node/stream.d.ts:43
#
removeAllListeners▸ removeAllListeners(event?
): ReadStream
#
ParametersName | Type |
---|---|
event? | string | symbol |
#
Returns#
Inherited fromstream.Readable.removeAllListeners
#
Defined innode_modules/@types/node/events.d.ts:67
#
removeListener▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "close" |
listener | () => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:120
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "data" |
listener | (chunk : any ) => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:121
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "end" |
listener | () => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:122
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "error" |
listener | (err : Error ) => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:123
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "pause" |
listener | () => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:124
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "readable" |
listener | () => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:125
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | "resume" |
listener | () => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:126
▸ removeListener(event
, listener
): ReadStream
#
ParametersName | Type |
---|---|
event | string | symbol |
listener | (...args : any []) => void |
#
Returns#
Inherited fromstream.Readable.removeListener
#
Defined innode_modules/@types/node/stream.d.ts:127
#
resume▸ resume(): ReadStream
#
Returns#
Inherited fromstream.Readable.resume
#
Defined innode_modules/@types/node/stream.d.ts:46
#
setEncoding▸ setEncoding(encoding
): ReadStream
#
ParametersName | Type |
---|---|
encoding | BufferEncoding |
#
Returns#
Inherited fromstream.Readable.setEncoding
#
Defined innode_modules/@types/node/stream.d.ts:44
#
setMaxListeners▸ setMaxListeners(n
): ReadStream
#
ParametersName | Type |
---|---|
n | number |
#
Returns#
Inherited fromstream.Readable.setMaxListeners
#
Defined innode_modules/@types/node/events.d.ts:68
#
unpipe▸ unpipe(destination?
): ReadStream
#
ParametersName | Type |
---|---|
destination? | WritableStream |
#
Returns#
Inherited fromstream.Readable.unpipe
#
Defined innode_modules/@types/node/stream.d.ts:48
#
unshift▸ unshift(chunk
, encoding?
): void
#
ParametersName | Type |
---|---|
chunk | any |
encoding? | BufferEncoding |
#
Returnsvoid
#
Inherited fromstream.Readable.unshift
#
Defined innode_modules/@types/node/stream.d.ts:49
#
wrap▸ wrap(oldStream
): ReadStream
#
ParametersName | Type |
---|---|
oldStream | ReadableStream |
#
Returns#
Inherited fromstream.Readable.wrap
#
Defined innode_modules/@types/node/stream.d.ts:50
#
from▸ Static
from(iterable
, options?
): Readable
A utility method for creating Readable Streams out of iterators.
#
ParametersName | Type |
---|---|
iterable | Iterable <any > | AsyncIterable <any > |
options? | ReadableOptions |
#
ReturnsReadable
#
Inherited fromstream.Readable.from
#
Defined innode_modules/@types/node/stream.d.ts:31
#
listenerCount▸ Static
listenerCount(emitter
, event
): number
deprecated
since v4.0.0
#
ParametersName | Type |
---|---|
emitter | EventEmitter |
event | string | symbol |
#
Returnsnumber
#
Inherited fromstream.Readable.listenerCount
#
Defined innode_modules/@types/node/events.d.ts:31
#
on▸ Static
on(emitter
, event
): AsyncIterableIterator
<any
>
#
ParametersName | Type |
---|---|
emitter | EventEmitter |
event | string |
#
ReturnsAsyncIterableIterator
<any
>
#
Inherited fromstream.Readable.on
#
Defined innode_modules/@types/node/events.d.ts:28
#
once▸ Static
once(emitter
, event
): Promise
<any
[]>
#
ParametersName | Type |
---|---|
emitter | NodeEventTarget |
event | string | symbol |
#
ReturnsPromise
<any
[]>
#
Inherited fromstream.Readable.once
#
Defined innode_modules/@types/node/events.d.ts:26
▸ Static
once(emitter
, event
): Promise
<any
[]>
#
ParametersName | Type |
---|---|
emitter | DOMEventTarget |
event | string |
#
ReturnsPromise
<any
[]>
#
Inherited fromstream.Readable.once
#
Defined innode_modules/@types/node/events.d.ts:27