Search
Preparing search index...
The search index is not available
typescript
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"node_modules/@types/node/fs.d"
"fs"
ReadStream
Class ReadStream
Hierarchy
Readable
ReadStream
Implements
ReadableStream
Index
Constructors
constructor
Properties
bytes
Read
path
readable
readable
High
Water
Mark
readable
Length
default
Max
Listeners
Methods
__@async
Iterator
_destroy
_read
add
Listener
close
destroy
emit
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
off
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
push
raw
Listeners
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
readable
High
Water
Mark
readable
High
Water
Mark
:
number
readable
Length
readable
Length
:
number
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
__@async
Iterator
__@async
Iterator
(
)
:
AsyncIterableIterator
<
any
>
Returns
AsyncIterableIterator
<
any
>
_destroy
_destroy
(
error
:
Error
|
null
, callback
:
function
)
:
void
Parameters
error:
Error
|
null
callback:
function
(
error
:
Error
|
null
)
:
void
Parameters
error:
Error
|
null
Returns
void
Returns
void
_read
_read
(
size
:
number
)
:
void
Parameters
size:
number
Returns
void
add
Listener
add
Listener
(
event
:
string
, listener
:
function
)
:
this
add
Listener
(
event
:
"open"
, listener
:
function
)
:
this
add
Listener
(
event
:
"close"
, listener
:
function
)
:
this
events.EventEmitter
open
close
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
close
close
(
)
:
void
Returns
void
destroy
destroy
(
error
?:
Error
)
:
void
Parameters
Optional
error:
Error
Returns
void
emit
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"data"
, chunk
:
any
)
:
boolean
emit
(
event
:
"end"
)
:
boolean
emit
(
event
:
"readable"
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"data"
chunk:
any
Returns
boolean
Parameters
event:
"end"
Returns
boolean
Parameters
event:
"readable"
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
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
[]
off
off
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
on
on
(
event
:
string
, listener
:
function
)
:
this
on
(
event
:
"open"
, listener
:
function
)
:
this
on
(
event
:
"close"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
once
once
(
event
:
string
, listener
:
function
)
:
this
once
(
event
:
"open"
, listener
:
function
)
:
this
once
(
event
:
"close"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
pause
pause
(
)
:
this
Returns
this
pipe
pipe<T>
(
destination
:
T
, options
?:
undefined
|
object
)
:
T
Type parameters
T
:
WritableStream
Parameters
destination:
T
Optional
options:
undefined
|
object
Returns
T
prepend
Listener
prepend
Listener
(
event
:
string
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"open"
, listener
:
function
)
:
this
prepend
Listener
(
event
:
"close"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"open"
, listener
:
function
)
:
this
prepend
Once
Listener
(
event
:
"close"
, listener
:
function
)
:
this
Parameters
event:
string
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
Parameters
event:
"open"
listener:
function
(
fd
:
number
)
:
void
Parameters
fd:
number
Returns
void
Returns
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
push
push
(
chunk
:
any
, encoding
?:
undefined
|
string
)
:
boolean
Parameters
chunk:
any
Optional
encoding:
undefined
|
string
Returns
boolean
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
read
read
(
size
?:
undefined
|
number
)
:
any
Parameters
Optional
size:
undefined
|
number
Returns
any
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
"close"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"data"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"end"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"readable"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"error"
, listener
:
function
)
:
this
remove
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"data"
listener:
function
(
chunk
:
any
)
:
void
Parameters
chunk:
any
Returns
void
Returns
this
Parameters
event:
"end"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"readable"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
resume
resume
(
)
:
this
Returns
this
set
Encoding
set
Encoding
(
encoding
:
string
)
:
this
Parameters
encoding:
string
Returns
this
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
unpipe
unpipe
(
destination
?:
WritableStream
)
:
this
Parameters
Optional
destination:
WritableStream
Returns
this
unshift
unshift
(
chunk
:
any
)
:
void
Parameters
chunk:
any
Returns
void
wrap
wrap
(
oldStream
:
ReadableStream
)
:
this
Parameters
oldStream:
ReadableStream
Returns
this
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
deprecated
since v4.0.0
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
"node_
modules/@types/node/fs.d"
"fs"
access
append
File
chmod
chown
close
constants
copy
File
exists
fchmod
fchown
fdatasync
fstat
fsync
ftruncate
futimes
lchmod
lchown
link
lstat
mkdir
mkdtemp
open
promises
read
read
File
readdir
readlink
realpath
realpath
Sync
rename
rmdir
stat
symlink
truncate
unlink
utimes
write
write
File
Read
Stream
constructor
bytes
Read
path
readable
readable
High
Water
Mark
readable
Length
default
Max
Listeners
__@async
Iterator
_destroy
_read
add
Listener
close
destroy
emit
event
Names
get
Max
Listeners
is
Paused
listener
Count
listeners
off
on
once
pause
pipe
prepend
Listener
prepend
Once
Listener
push
raw
Listeners
read
remove
All
Listeners
remove
Listener
resume
set
Encoding
set
Max
Listeners
unpipe
unshift
wrap
listener
Count
Generated using
TypeDoc
events.EventEmitter