Skip to main content

fs.readstream

@listenai/lisa_core / Exports / fs / ReadStream

Class: ReadStream

fs.ReadStream

Hierarchy#

  • Readable

    ReadStream

Table of contents#

Constructors#

Properties#

Methods#

Constructors#

constructor#

new ReadStream(opts?)

Parameters#

NameType
opts?ReadableOptions

Inherited from#

stream.Readable.constructor

Defined in#

node_modules/@types/node/stream.d.ts:40

Properties#

bytesRead#

bytesRead: number

Defined in#

node_modules/@types/node/fs.d.ts:151


destroyed#

destroyed: boolean

Inherited from#

stream.Readable.destroyed

Defined in#

node_modules/@types/node/stream.d.ts:40


path#

path: string | Buffer

Defined in#

node_modules/@types/node/fs.d.ts:152


pending#

pending: boolean

Defined in#

node_modules/@types/node/fs.d.ts:153


readable#

readable: boolean

Inherited from#

stream.Readable.readable

Defined in#

node_modules/@types/node/stream.d.ts:33


readableEncoding#

Readonly readableEncoding: null | BufferEncoding

Inherited from#

stream.Readable.readableEncoding

Defined in#

node_modules/@types/node/stream.d.ts:34


readableEnded#

Readonly readableEnded: boolean

Inherited from#

stream.Readable.readableEnded

Defined in#

node_modules/@types/node/stream.d.ts:35


readableFlowing#

Readonly readableFlowing: null | boolean

Inherited from#

stream.Readable.readableFlowing

Defined in#

node_modules/@types/node/stream.d.ts:36


readableHighWaterMark#

Readonly readableHighWaterMark: number

Inherited from#

stream.Readable.readableHighWaterMark

Defined in#

node_modules/@types/node/stream.d.ts:37


readableLength#

Readonly readableLength: number

Inherited from#

stream.Readable.readableLength

Defined in#

node_modules/@types/node/stream.d.ts:38


readableObjectMode#

Readonly readableObjectMode: boolean

Inherited from#

stream.Readable.readableObjectMode

Defined in#

node_modules/@types/node/stream.d.ts:39


captureRejectionSymbol#

Static Readonly captureRejectionSymbol: typeof captureRejectionSymbol

Inherited from#

stream.Readable.captureRejectionSymbol

Defined in#

node_modules/@types/node/events.d.ts:43


captureRejections#

Static captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Inherited from#

stream.Readable.captureRejections

Defined in#

node_modules/@types/node/events.d.ts:49


defaultMaxListeners#

Static defaultMaxListeners: number

Inherited from#

stream.Readable.defaultMaxListeners

Defined in#

node_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 from#

stream.Readable.errorMonitor

Defined in#

node_modules/@types/node/events.d.ts:42

Methods#

[Symbol.asyncIterator]#

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

Returns#

AsyncIterableIterator<any>

Inherited from#

stream.Readable.__@asyncIterator

Defined in#

node_modules/@types/node/stream.d.ts:129


_destroy#

_destroy(error, callback): void

Parameters#

NameType
errornull | Error
callback(error?: null | Error) => void

Returns#

void

Inherited from#

stream.Readable._destroy

Defined in#

node_modules/@types/node/stream.d.ts:52


_read#

_read(size): void

Parameters#

NameType
sizenumber

Returns#

void

Inherited from#

stream.Readable._read

Defined in#

node_modules/@types/node/stream.d.ts:42


addListener#

addListener(event, listener): ReadStream

events.EventEmitter

  1. open
  2. close
  3. ready

Parameters#

NameType
event"close"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:161

addListener(event, listener): ReadStream

Parameters#

NameType
event"data"
listener(chunk: string | Buffer) => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:162

addListener(event, listener): ReadStream

Parameters#

NameType
event"end"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:163

addListener(event, listener): ReadStream

Parameters#

NameType
event"error"
listener(err: Error) => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:164

addListener(event, listener): ReadStream

Parameters#

NameType
event"open"
listener(fd: number) => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:165

addListener(event, listener): ReadStream

Parameters#

NameType
event"pause"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:166

addListener(event, listener): ReadStream

Parameters#

NameType
event"readable"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:167

addListener(event, listener): ReadStream

Parameters#

NameType
event"ready"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:168

addListener(event, listener): ReadStream

Parameters#

NameType
event"resume"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:169

addListener(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Overrides#

stream.Readable.addListener

Defined in#

node_modules/@types/node/fs.d.ts:170


close#

close(): void

Returns#

void

Defined in#

node_modules/@types/node/fs.d.ts:150


destroy#

destroy(error?): void

Parameters#

NameType
error?Error

Returns#

void

Inherited from#

stream.Readable.destroy

Defined in#

node_modules/@types/node/stream.d.ts:53


emit#

emit(event): boolean

Parameters#

NameType
event"close"

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:75

emit(event, chunk): boolean

Parameters#

NameType
event"data"
chunkany

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:76

emit(event): boolean

Parameters#

NameType
event"end"

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:77

emit(event, err): boolean

Parameters#

NameType
event"error"
errError

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:78

emit(event): boolean

Parameters#

NameType
event"pause"

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:79

emit(event): boolean

Parameters#

NameType
event"readable"

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:80

emit(event): boolean

Parameters#

NameType
event"resume"

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:81

emit(event, ...args): boolean

Parameters#

NameType
eventstring | symbol
...argsany[]

Returns#

boolean

Inherited from#

stream.Readable.emit

Defined in#

node_modules/@types/node/stream.d.ts:82


eventNames#

eventNames(): (string | symbol)[]

Returns#

(string | symbol)[]

Inherited from#

stream.Readable.eventNames

Defined in#

node_modules/@types/node/events.d.ts:77


getMaxListeners#

getMaxListeners(): number

Returns#

number

Inherited from#

stream.Readable.getMaxListeners

Defined in#

node_modules/@types/node/events.d.ts:69


isPaused#

isPaused(): boolean

Returns#

boolean

Inherited from#

stream.Readable.isPaused

Defined in#

node_modules/@types/node/stream.d.ts:47


listenerCount#

listenerCount(event): number

Parameters#

NameType
eventstring | symbol

Returns#

number

Inherited from#

stream.Readable.listenerCount

Defined in#

node_modules/@types/node/events.d.ts:73


listeners#

listeners(event): Function[]

Parameters#

NameType
eventstring | symbol

Returns#

Function[]

Inherited from#

stream.Readable.listeners

Defined in#

node_modules/@types/node/events.d.ts:70


off#

off(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Inherited from#

stream.Readable.off

Defined in#

node_modules/@types/node/events.d.ts:66


on#

on(event, listener): ReadStream

Parameters#

NameType
event"close"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:172

on(event, listener): ReadStream

Parameters#

NameType
event"data"
listener(chunk: string | Buffer) => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:173

on(event, listener): ReadStream

Parameters#

NameType
event"end"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:174

on(event, listener): ReadStream

Parameters#

NameType
event"error"
listener(err: Error) => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:175

on(event, listener): ReadStream

Parameters#

NameType
event"open"
listener(fd: number) => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:176

on(event, listener): ReadStream

Parameters#

NameType
event"pause"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:177

on(event, listener): ReadStream

Parameters#

NameType
event"readable"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:178

on(event, listener): ReadStream

Parameters#

NameType
event"ready"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:179

on(event, listener): ReadStream

Parameters#

NameType
event"resume"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:180

on(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Overrides#

stream.Readable.on

Defined in#

node_modules/@types/node/fs.d.ts:181


once#

once(event, listener): ReadStream

Parameters#

NameType
event"close"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:183

once(event, listener): ReadStream

Parameters#

NameType
event"data"
listener(chunk: string | Buffer) => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:184

once(event, listener): ReadStream

Parameters#

NameType
event"end"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:185

once(event, listener): ReadStream

Parameters#

NameType
event"error"
listener(err: Error) => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:186

once(event, listener): ReadStream

Parameters#

NameType
event"open"
listener(fd: number) => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:187

once(event, listener): ReadStream

Parameters#

NameType
event"pause"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:188

once(event, listener): ReadStream

Parameters#

NameType
event"readable"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:189

once(event, listener): ReadStream

Parameters#

NameType
event"ready"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:190

once(event, listener): ReadStream

Parameters#

NameType
event"resume"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:191

once(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Overrides#

stream.Readable.once

Defined in#

node_modules/@types/node/fs.d.ts:192


pause#

pause(): ReadStream

Returns#

ReadStream

Inherited from#

stream.Readable.pause

Defined in#

node_modules/@types/node/stream.d.ts:45


pipe#

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

Type parameters#

NameType
Textends WritableStream<T>

Parameters#

NameType
destinationT
options?Object
options.end?boolean

Returns#

T

Inherited from#

stream.Readable.pipe

Defined in#

node_modules/@types/node/stream.d.ts:10


prependListener#

prependListener(event, listener): ReadStream

Parameters#

NameType
event"close"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:194

prependListener(event, listener): ReadStream

Parameters#

NameType
event"data"
listener(chunk: string | Buffer) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:195

prependListener(event, listener): ReadStream

Parameters#

NameType
event"end"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:196

prependListener(event, listener): ReadStream

Parameters#

NameType
event"error"
listener(err: Error) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:197

prependListener(event, listener): ReadStream

Parameters#

NameType
event"open"
listener(fd: number) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:198

prependListener(event, listener): ReadStream

Parameters#

NameType
event"pause"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:199

prependListener(event, listener): ReadStream

Parameters#

NameType
event"readable"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:200

prependListener(event, listener): ReadStream

Parameters#

NameType
event"ready"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:201

prependListener(event, listener): ReadStream

Parameters#

NameType
event"resume"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:202

prependListener(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependListener

Defined in#

node_modules/@types/node/fs.d.ts:203


prependOnceListener#

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"close"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:205

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"data"
listener(chunk: string | Buffer) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:206

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"end"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:207

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"error"
listener(err: Error) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:208

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"open"
listener(fd: number) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:209

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"pause"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:210

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"readable"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:211

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"ready"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:212

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
event"resume"
listener() => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:213

prependOnceListener(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Overrides#

stream.Readable.prependOnceListener

Defined in#

node_modules/@types/node/fs.d.ts:214


push#

push(chunk, encoding?): boolean

Parameters#

NameType
chunkany
encoding?BufferEncoding

Returns#

boolean

Inherited from#

stream.Readable.push

Defined in#

node_modules/@types/node/stream.d.ts:51


rawListeners#

rawListeners(event): Function[]

Parameters#

NameType
eventstring | symbol

Returns#

Function[]

Inherited from#

stream.Readable.rawListeners

Defined in#

node_modules/@types/node/events.d.ts:71


read#

read(size?): any

Parameters#

NameType
size?number

Returns#

any

Inherited from#

stream.Readable.read

Defined in#

node_modules/@types/node/stream.d.ts:43


removeAllListeners#

removeAllListeners(event?): ReadStream

Parameters#

NameType
event?string | symbol

Returns#

ReadStream

Inherited from#

stream.Readable.removeAllListeners

Defined in#

node_modules/@types/node/events.d.ts:67


removeListener#

removeListener(event, listener): ReadStream

Parameters#

NameType
event"close"
listener() => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:120

removeListener(event, listener): ReadStream

Parameters#

NameType
event"data"
listener(chunk: any) => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:121

removeListener(event, listener): ReadStream

Parameters#

NameType
event"end"
listener() => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:122

removeListener(event, listener): ReadStream

Parameters#

NameType
event"error"
listener(err: Error) => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:123

removeListener(event, listener): ReadStream

Parameters#

NameType
event"pause"
listener() => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:124

removeListener(event, listener): ReadStream

Parameters#

NameType
event"readable"
listener() => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:125

removeListener(event, listener): ReadStream

Parameters#

NameType
event"resume"
listener() => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:126

removeListener(event, listener): ReadStream

Parameters#

NameType
eventstring | symbol
listener(...args: any[]) => void

Returns#

ReadStream

Inherited from#

stream.Readable.removeListener

Defined in#

node_modules/@types/node/stream.d.ts:127


resume#

resume(): ReadStream

Returns#

ReadStream

Inherited from#

stream.Readable.resume

Defined in#

node_modules/@types/node/stream.d.ts:46


setEncoding#

setEncoding(encoding): ReadStream

Parameters#

NameType
encodingBufferEncoding

Returns#

ReadStream

Inherited from#

stream.Readable.setEncoding

Defined in#

node_modules/@types/node/stream.d.ts:44


setMaxListeners#

setMaxListeners(n): ReadStream

Parameters#

NameType
nnumber

Returns#

ReadStream

Inherited from#

stream.Readable.setMaxListeners

Defined in#

node_modules/@types/node/events.d.ts:68


unpipe#

unpipe(destination?): ReadStream

Parameters#

NameType
destination?WritableStream

Returns#

ReadStream

Inherited from#

stream.Readable.unpipe

Defined in#

node_modules/@types/node/stream.d.ts:48


unshift#

unshift(chunk, encoding?): void

Parameters#

NameType
chunkany
encoding?BufferEncoding

Returns#

void

Inherited from#

stream.Readable.unshift

Defined in#

node_modules/@types/node/stream.d.ts:49


wrap#

wrap(oldStream): ReadStream

Parameters#

NameType
oldStreamReadableStream

Returns#

ReadStream

Inherited from#

stream.Readable.wrap

Defined in#

node_modules/@types/node/stream.d.ts:50


from#

Static from(iterable, options?): Readable

A utility method for creating Readable Streams out of iterators.

Parameters#

NameType
iterableIterable<any> | AsyncIterable<any>
options?ReadableOptions

Returns#

Readable

Inherited from#

stream.Readable.from

Defined in#

node_modules/@types/node/stream.d.ts:31


listenerCount#

Static listenerCount(emitter, event): number

deprecated since v4.0.0

Parameters#

NameType
emitterEventEmitter
eventstring | symbol

Returns#

number

Inherited from#

stream.Readable.listenerCount

Defined in#

node_modules/@types/node/events.d.ts:31


on#

Static on(emitter, event): AsyncIterableIterator<any>

Parameters#

NameType
emitterEventEmitter
eventstring

Returns#

AsyncIterableIterator<any>

Inherited from#

stream.Readable.on

Defined in#

node_modules/@types/node/events.d.ts:28


once#

Static once(emitter, event): Promise<any[]>

Parameters#

NameType
emitterNodeEventTarget
eventstring | symbol

Returns#

Promise<any[]>

Inherited from#

stream.Readable.once

Defined in#

node_modules/@types/node/events.d.ts:26

Static once(emitter, event): Promise<any[]>

Parameters#

NameType
emitterDOMEventTarget
eventstring

Returns#

Promise<any[]>

Inherited from#

stream.Readable.once

Defined in#

node_modules/@types/node/events.d.ts:27

  • 没帮助 0