Search
Preparing search index...
The search index is not available
DefinitelyTyped
Inherited
Private
Externals
Only exported
fs
ReadStream
Class ReadStream
Hierarchy
Readable
ReadStream
Index
Constructor methods
constructor
Properties
readable
Methods
_read
addListener
emit
listeners
on
once
pause
pipe
push
read
removeAllListeners
removeListener
resume
setEncoding
setMaxListeners
unpipe
unshift
wrap
Constructor methods
constructor
(
opts
?:
ReadableOptions
)
:
Readable
Parameters
opts?:
ReadableOptions
optional
Returns
Readable
Properties
public
readable
:
boolean
Methods
public
_read
(
size
:
number
)
Parameters
size:
number
public
addListener
(
event
:
string
, listener
:
Function
)
:
EventEmitter
Parameters
event:
string
listener:
Function
Returns
EventEmitter
public
emit
(
event
:
string
, args
?:
Array<any>
)
:
boolean
Parameters
event:
string
args?:
Array<any>
optional
Returns
boolean
public
listeners
(
event
:
string
)
:
Array<Function>
Parameters
event:
string
Returns
Array<Function>
public
on
(
event
:
string
, listener
:
Function
)
:
EventEmitter
Parameters
event:
string
listener:
Function
Returns
EventEmitter
public
once
(
event
:
string
, listener
:
Function
)
:
EventEmitter
Parameters
event:
string
listener:
Function
Returns
EventEmitter
public
pause
(
)
public
pipe
(
destination
:
T
, options
?:
{ end?: boolean; }
)
:
T
Parameters
destination:
T
options?:
{ end?: boolean; }
optional
Returns
T
public
push
(
chunk
:
any
, encoding
?:
string
)
:
boolean
Parameters
chunk:
any
encoding?:
string
optional
Returns
boolean
public
read
(
size
?:
number
)
:
any
Parameters
size?:
number
optional
Returns
any
public
removeAllListeners
(
event
?:
string
)
:
EventEmitter
Parameters
event?:
string
optional
Returns
EventEmitter
public
removeListener
(
event
:
string
, listener
:
Function
)
:
EventEmitter
Parameters
event:
string
listener:
Function
Returns
EventEmitter
public
resume
(
)
public
setEncoding
(
encoding
:
string
)
Parameters
encoding:
string
public
setMaxListeners
(
n
:
number
)
Parameters
n:
number
public
unpipe
(
destination
?:
T
)
Parameters
destination?:
T
optional
public
unshift
(
chunk
:
string
)
Parameters
chunk:
string
public
unshift
(
chunk
:
Buffer
)
Parameters
chunk:
Buffer
public
wrap
(
oldStream
:
ReadableStream
)
:
ReadableStream
Parameters
oldStream:
ReadableStream
Returns
ReadableStream
Globals
NodeJS
assert
buffer
child_process
cluster
crypto
dgram
dns
domain
events
fs
http
https
net
os
path
punycode
querystring
readline
repl
stream
string_decoder
tls
tty
url
util
vm
zlib
Stats
FSWatcher
ReadStream
constructor
readable
_read
addListener
emit
listeners
on
once
pause
pipe
push
read
removeAllListeners
removeListener
resume
setEncoding
setMaxListeners
unpipe
unshift
wrap
WriteStream
appendFile
appendFileSync
chmod
chmodSync
chown
chownSync
close
closeSync
createReadStream
createWriteStream
exists
existsSync
fchmod
fchmodSync
fchown
fchownSync
fstat
fstatSync
fsync
fsyncSync
ftruncate
ftruncateSync
futimes
futimesSync
lchmod
lchmodSync
lchown
lchownSync
link
linkSync
lstat
lstatSync
mkdir
mkdirSync
open
openSync
read
readFile
readFileSync
readSync
readdir
readdirSync
readlink
readlinkSync
realpath
realpathSync
rename
renameSync
rmdir
rmdirSync
stat
statSync
symlink
symlinkSync
truncate
truncateSync
unlink
unlinkSync
unwatchFile
utimes
utimesSync
watch
watchFile
write
writeFile
writeFileSync
writeSync