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"
WriteStream
Class WriteStream
Hierarchy
Writable
WriteStream
Implements
WritableStream
Index
Constructors
constructor
Properties
bytes
Written
path
writable
writable
High
Water
Mark
writable
Length
default
Max
Listeners
Methods
_destroy
_final
_write
_writev
add
Listener
close
cork
destroy
emit
end
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
pipe
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Default
Encoding
set
Max
Listeners
uncork
write
listener
Count
Constructors
constructor
new
Write
Stream
(
opts
?:
WritableOptions
)
:
WriteStream
Parameters
Optional
opts:
WritableOptions
Returns
WriteStream
Properties
bytes
Written
bytes
Written
:
number
path
path
:
string
|
Buffer
writable
writable
:
boolean
writable
High
Water
Mark
writable
High
Water
Mark
:
number
writable
Length
writable
Length
:
number
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
_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
_final
_final
(
callback
:
function
)
:
void
Parameters
callback:
function
(
error
?:
Error
|
null
)
:
void
Parameters
Optional
error:
Error
|
null
Returns
void
Returns
void
_write
_write
(
chunk
:
any
, encoding
:
string
, callback
:
function
)
:
void
Parameters
chunk:
any
encoding:
string
callback:
function
(
error
?:
Error
|
null
)
:
void
Parameters
Optional
error:
Error
|
null
Returns
void
Returns
void
Optional
_writev
_writev
(
chunks
:
Array
<
object
>
, callback
:
function
)
:
void
Parameters
chunks:
Array
<
object
>
callback:
function
(
error
?:
Error
|
null
)
:
void
Parameters
Optional
error:
Error
|
null
Returns
void
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
cork
cork
(
)
:
void
Returns
void
destroy
destroy
(
error
?:
Error
)
:
void
Parameters
Optional
error:
Error
Returns
void
emit
emit
(
event
:
"close"
)
:
boolean
emit
(
event
:
"drain"
)
:
boolean
emit
(
event
:
"error"
, err
:
Error
)
:
boolean
emit
(
event
:
"finish"
)
:
boolean
emit
(
event
:
"pipe"
, src
:
Readable
)
:
boolean
emit
(
event
:
"unpipe"
, src
:
Readable
)
:
boolean
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
"close"
Returns
boolean
Parameters
event:
"drain"
Returns
boolean
Parameters
event:
"error"
err:
Error
Returns
boolean
Parameters
event:
"finish"
Returns
boolean
Parameters
event:
"pipe"
src:
Readable
Returns
boolean
Parameters
event:
"unpipe"
src:
Readable
Returns
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
end
end
(
cb
?:
undefined
|
function
)
:
void
end
(
chunk
:
any
, cb
?:
undefined
|
function
)
:
void
end
(
chunk
:
any
, encoding
?:
undefined
|
string
, cb
?:
undefined
|
function
)
:
void
Parameters
Optional
cb:
undefined
|
function
Returns
void
Parameters
chunk:
any
Optional
cb:
undefined
|
function
Returns
void
Parameters
chunk:
any
Optional
encoding:
undefined
|
string
Optional
cb:
undefined
|
function
Returns
void
event
Names
event
Names
(
)
:
Array
<
string
|
symbol
>
Returns
Array
<
string
|
symbol
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
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
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
raw
Listeners
raw
Listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
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
:
"drain"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"error"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"finish"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"pipe"
, listener
:
function
)
:
this
remove
Listener
(
event
:
"unpipe"
, listener
:
function
)
:
this
remove
Listener
(
event
:
string
|
symbol
, listener
:
function
)
:
this
Parameters
event:
"close"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"drain"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Error
)
:
void
Parameters
err:
Error
Returns
void
Returns
this
Parameters
event:
"finish"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"pipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
"unpipe"
listener:
function
(
src
:
Readable
)
:
void
Parameters
src:
Readable
Returns
void
Returns
this
Parameters
event:
string
|
symbol
listener:
function
(
...
args
:
any
[]
)
:
void
Parameters
Rest
...
args:
any
[]
Returns
void
Returns
this
set
Default
Encoding
set
Default
Encoding
(
encoding
:
string
)
:
this
Parameters
encoding:
string
Returns
this
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
uncork
uncork
(
)
:
void
Returns
void
write
write
(
chunk
:
any
, cb
?:
undefined
|
function
)
:
boolean
write
(
chunk
:
any
, encoding
?:
undefined
|
string
, cb
?:
undefined
|
function
)
:
boolean
Parameters
chunk:
any
Optional
cb:
undefined
|
function
Returns
boolean
Parameters
chunk:
any
Optional
encoding:
undefined
|
string
Optional
cb:
undefined
|
function
Returns
boolean
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
Write
Stream
constructor
bytes
Written
path
writable
writable
High
Water
Mark
writable
Length
default
Max
Listeners
_destroy
_final
_write
_writev
add
Listener
close
cork
destroy
emit
end
event
Names
get
Max
Listeners
listener
Count
listeners
off
on
once
pipe
prepend
Listener
prepend
Once
Listener
raw
Listeners
remove
All
Listeners
remove
Listener
set
Default
Encoding
set
Max
Listeners
uncork
write
listener
Count
Generated using
TypeDoc
events.EventEmitter