WebCola
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Read
Stream
constructor
bytes
Read
path
readable
default
Max
Listeners
_read
add
Listener
close
destroy
emit
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
push
read
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Max
Listeners
unpipe
unshift
wrap
listener
Count
Hierarchy
Readable
ReadStream
Implements
ReadableStream
Index
Constructors
constructor
Properties
bytes
Read
path
readable
default
Max
Listeners
Methods
_read
add
Listener
close
destroy
emit
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
push
read
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Max
Listeners
unpipe
unshift
wrap
listener
Count
Constructors
constructor
new
Read
Stream
(
opts
?:
ReadableOptions
)
:
ReadStream
Parameters
Optional
opts:
ReadableOptions
Returns
ReadStream
Properties
bytes
Read
bytes
Read
:
number
path
path
:
string
|
Buffer
readable
readable
:
boolean
default
Max
Listeners
default
Max
Listeners
:
number
Methods
_read
_read
(
size
:
number
)
:
void
Parameters
size:
number
Returns
void
add
Listener
add
Listener
(
event
:
string
, listener
:
Function
)
add
Listener
(
event
:
"open"
, listener
:
function
)
add
Listener
(
event
:
"close"
, listener
:
function
)
events.EventEmitter
open
close
Parameters
event:
string
listener:
Function
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
close
close
(
)
:
void
Returns
void
destroy
destroy
(
)
:
void
Returns
void
emit
emit
(
event
:
string
,
...
args
:
any
[]
)
:
boolean
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"data"
, chunk
:
Buffer
|
string
)
:
boolean
emit
(
event
:
"end"
)
:
boolean
emit
(
event
:
"readable"
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
Parameters
event:
string
Rest
...
args:
any
[]
Returns
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"data"
chunk:
Buffer
|
string
Returns
boolean
Parameters
event:
"end"
Returns
boolean
Parameters
event:
"readable"
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
event
Names
event
Names
(
)
:
string
|
symbol
Returns
string
|
symbol
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
is
Paused
is
Paused
(
)
:
boolean
Returns
boolean
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
on
on
(
event
:
string
, listener
:
Function
)
on
(
event
:
"open"
, listener
:
function
)
on
(
event
:
"close"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
once
once
(
event
:
string
, listener
:
Function
)
once
(
event
:
"open"
, listener
:
function
)
once
(
event
:
"close"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
pause
pause
(
)
pipe
pipe<T>
(
destination
:
T
, options
?:
object
)
:
T
Type parameters
T
:
WritableStream
Parameters
destination:
T
Optional
options:
object
Optional
end
?:
boolean
Returns
T
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
Function
)
prepend
Listener
(
event
:
"open"
, listener
:
function
)
prepend
Listener
(
event
:
"close"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
Function
)
prepend
Once
Listener
(
event
:
"open"
, listener
:
function
)
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
push
push
(
chunk
:
any
, encoding
?:
string
)
:
boolean
Parameters
chunk:
any
Optional
encoding:
string
Returns
boolean
read
read
(
size
?:
number
)
:
any
Parameters
Optional
size:
number
Returns
any
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
Parameters
Optional
event:
string
|
symbol
remove
Listener
remove
Listener
(
event
:
string
, listener
:
Function
)
remove
Listener
(
event
:
"close"
, listener
:
function
)
remove
Listener
(
event
:
"data"
, listener
:
function
)
remove
Listener
(
event
:
"end"
, listener
:
function
)
remove
Listener
(
event
:
"readable"
, listener
:
function
)
remove
Listener
(
event
:
"error"
, listener
:
function
)
Parameters
event:
string
listener:
Function
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"data"
listener:
function
(
chunk
:
Buffer
|
string
)
:
void
Parameters
chunk:
Buffer
|
string
Returns
void
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
resume
resume
(
)
set
Encoding
set
Encoding
(
encoding
:
string
)
Parameters
encoding:
string
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
Parameters
n:
number
unpipe
unpipe<T>
(
destination
?:
T
)
Type parameters
T
:
WritableStream
Parameters
Optional
destination:
T
unshift
unshift
(
chunk
:
any
)
:
void
Parameters
chunk:
any
Returns
void
wrap
wrap
(
oldStream
:
ReadableStream
)
:
ReadableStream
Parameters
oldStream:
ReadableStream
Returns
ReadableStream
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Generated using
TypeDoc
events.EventEmitter