Readable
Nodepod API / src / stream / Readable
Interface: Readable
Section titled “Interface: Readable”Defined in: src/polyfills/stream.ts:40
Extends
Section titled “Extends”Extended by
Section titled “Extended by”Properties
Section titled “Properties”_ceiling
Section titled “_ceiling”_ceiling:
number
Defined in: src/polyfills/events.ts:88
Inherited from
Section titled “Inherited from”_readableState
Section titled “_readableState”_readableState:
any
Defined in: src/polyfills/stream.ts:51
_registry
Section titled “_registry”_registry:
Map<string,EventHandler[]>
Defined in: src/polyfills/events.ts:87
Inherited from
Section titled “Inherited from”closed
Section titled “closed”closed:
boolean
Defined in: src/polyfills/stream.ts:45
destroyed
Section titled “destroyed”destroyed:
boolean
Defined in: src/polyfills/stream.ts:44
errored
Section titled “errored”errored:
Error|null
Defined in: src/polyfills/stream.ts:46
readable
Section titled “readable”readable:
boolean
Defined in: src/polyfills/stream.ts:41
readableAborted
Section titled “readableAborted”readableAborted:
boolean
Defined in: src/polyfills/stream.ts:50
readableDidRead
Section titled “readableDidRead”readableDidRead:
boolean
Defined in: src/polyfills/stream.ts:49
readableEncoding
Section titled “readableEncoding”
readonlyreadableEncoding:BufferEncoding|null
Defined in: src/polyfills/stream.ts:55
readableEnded
Section titled “readableEnded”readableEnded:
boolean
Defined in: src/polyfills/stream.ts:42
readableFlowing
Section titled “readableFlowing”readableFlowing:
boolean|null
Defined in: src/polyfills/stream.ts:43
readableHighWaterMark
Section titled “readableHighWaterMark”readableHighWaterMark:
number
Defined in: src/polyfills/stream.ts:48
readableLength
Section titled “readableLength”
readonlyreadableLength:number
Defined in: src/polyfills/stream.ts:54
readableObjectMode
Section titled “readableObjectMode”readableObjectMode:
boolean
Defined in: src/polyfills/stream.ts:47
Methods
Section titled “Methods”_destroy()
Section titled “_destroy()”_destroy(
err,cb):void
Defined in: src/polyfills/stream.ts:53
Parameters
Section titled “Parameters”Error | null
(err?) => void
Returns
Section titled “Returns”void
_rawBind()
Section titled “_rawBind()”_rawBind(
evt,fn):this
Defined in: src/polyfills/stream.ts:56
Parameters
Section titled “Parameters”string | symbol
(…args) => void
Returns
Section titled “Returns”this
_read()
Section titled “_read()”_read(
size):void
Defined in: src/polyfills/stream.ts:52
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
[asyncIterator]()
Section titled “[asyncIterator]()”[asyncIterator]():
AsyncIterableIterator<unknown>
Defined in: src/polyfills/stream.ts:72
Returns
Section titled “Returns”AsyncIterableIterator<unknown>
addListener()
Section titled “addListener()”addListener(
evt,fn):this
Defined in: src/polyfills/stream.ts:58
Parameters
Section titled “Parameters”string | symbol
(…args) => void
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”close()
Section titled “close()”close(
cb?):void
Defined in: src/polyfills/stream.ts:69
Parameters
Section titled “Parameters”(err?) => void
Returns
Section titled “Returns”void
destroy()
Section titled “destroy()”destroy(
fault?):this
Defined in: src/polyfills/stream.ts:70
Parameters
Section titled “Parameters”fault?
Section titled “fault?”Error
Returns
Section titled “Returns”this
emit()
Section titled “emit()”emit(
name, …payload):boolean
Defined in: src/polyfills/events.ts:95
Parameters
Section titled “Parameters”string
payload
Section titled “payload”…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”eventNames()
Section titled “eventNames()”eventNames():
string[]
Defined in: src/polyfills/events.ts:99
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”getMaxListeners()
Section titled “getMaxListeners()”getMaxListeners():
number
Defined in: src/polyfills/events.ts:101
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”isPaused()
Section titled “isPaused()”isPaused():
boolean
Defined in: src/polyfills/stream.ts:65
Returns
Section titled “Returns”boolean
listenerCount()
Section titled “listenerCount()”listenerCount(
name):number
Defined in: src/polyfills/events.ts:98
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”listeners()
Section titled “listeners()”listeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:96
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”off(
name,handler):this
Defined in: src/polyfills/events.ts:93
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”on(
evt,fn):this
Defined in: src/polyfills/stream.ts:57
Parameters
Section titled “Parameters”string | symbol
(…args) => void
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”once()
Section titled “once()”once(
evt,fn):this
Defined in: src/polyfills/stream.ts:59
Parameters
Section titled “Parameters”string | symbol
(…args) => void
Returns
Section titled “Returns”this
Overrides
Section titled “Overrides”pause()
Section titled “pause()”pause():
this
Defined in: src/polyfills/stream.ts:64
Returns
Section titled “Returns”this
pipe()
Section titled “pipe()”pipe(
target):any
Defined in: src/polyfills/stream.ts:66
Parameters
Section titled “Parameters”target
Section titled “target”any
Returns
Section titled “Returns”any
prependListener()
Section titled “prependListener()”prependListener(
name,handler):this
Defined in: src/polyfills/events.ts:102
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”prependOnceListener()
Section titled “prependOnceListener()”prependOnceListener(
name,handler):this
Defined in: src/polyfills/events.ts:103
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.prependOnceListener
push()
Section titled “push()”push(
chunk):boolean
Defined in: src/polyfills/stream.ts:60
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”boolean
rawListeners()
Section titled “rawListeners()”rawListeners(
name):EventHandler[]
Defined in: src/polyfills/events.ts:97
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”read()
Section titled “read()”read(
amount?):any
Defined in: src/polyfills/stream.ts:62
Parameters
Section titled “Parameters”amount?
Section titled “amount?”number
Returns
Section titled “Returns”any
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
name?):this
Defined in: src/polyfills/events.ts:94
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
name,handler):this
Defined in: src/polyfills/events.ts:92
Parameters
Section titled “Parameters”string
handler
Section titled “handler”Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”resume()
Section titled “resume()”resume():
this
Defined in: src/polyfills/stream.ts:63
Returns
Section titled “Returns”this
setEncoding()
Section titled “setEncoding()”setEncoding(
enc):this
Defined in: src/polyfills/stream.ts:68
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”this
setMaxListeners()
Section titled “setMaxListeners()”setMaxListeners(
limit):this
Defined in: src/polyfills/events.ts:100
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”unpipe()
Section titled “unpipe()”unpipe(
target?):this
Defined in: src/polyfills/stream.ts:67
Parameters
Section titled “Parameters”target?
Section titled “target?”any
Returns
Section titled “Returns”this
unshift()
Section titled “unshift()”unshift(
chunk):void
Defined in: src/polyfills/stream.ts:61
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
wrap()
Section titled “wrap()”wrap(
oldStream):this
Defined in: src/polyfills/stream.ts:71
Parameters
Section titled “Parameters”oldStream
Section titled “oldStream”Returns
Section titled “Returns”this