WriteStream
Related Docs:
object WriteStream
| package fs
All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.
All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.
The chunk to be written. Will always be a buffer unless the decodeStrings option was set to false.
Call this function (optionally with an error argument) when processing is complete for the supplied chunk.
All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.
All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.
The chunk to be written. Will always be a buffer unless the decodeStrings option was set to false.
If the chunk is a string, then encoding is the character encoding of that string. If chunk is a Buffer, or if the stream is operating in object mode, encoding may be ignored.
Call this function (optionally with an error argument) when processing is complete for the supplied chunk.
The writable._writev() method may be implemented in addition to writable._write() in stream implementations that are capable of processing multiple chunks of data at once.
The writable._writev() method may be implemented in addition to writable._write() in stream implementations that are capable of processing multiple chunks of data at once. If implemented, the method will be called with all chunks of data currently buffered in the write queue.
The chunks to be written. Each chunk has following format: { chunk: ..., encoding: ... }.
A callback function (optionally with an error argument) to be invoked when processing is complete for the supplied chunks.
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
emitter.addListener(eventName, listener)
on()
The number of bytes written so far.
The number of bytes written so far. Does not include data that is still queued for writing.
Undocumented method
Undocumented method
https://github.com/nodejs/node-v0.x-archive/blob/cfcb1de130867197cbc9c6012b7e84e08e53d032/lib/fs.js#L1597-L1620
Forces buffering of all writes.
Forces buffering of all writes. Buffered data will be flushed either at stream.uncork() or at stream.end() call.
writable.cork()
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Returns true if the event had listeners, false otherwise.
the event name
the event arguments
emitter.emit(name[, arg1][, arg2][, ...])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
writable.end([chunk][, encoding][, callback])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
the Callback for when this chunk of data is flushed
writable.end([chunk][, encoding][, callback])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
The data to write (<String> | <Buffer>)
writable.end([chunk][, encoding][, callback])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
The data to write (<String> | <Buffer>)
The encoding, if chunk is a String
writable.end([chunk][, encoding][, callback])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
The data to write (<String> | <Buffer>)
The encoding, if chunk is a String
writable.end([chunk][, encoding][, callback])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
The data to write (<String> | <Buffer>)
writable.end([chunk][, encoding][, callback])
Call this method when no more data will be written to the stream.
Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.
The data to write (<String> | <Buffer>)
the Callback for when this chunk of data is flushed
writable.end([chunk][, encoding][, callback])
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
emitter.getMaxListeners()
setMaxListeners()
Returns the number of listeners listening to the event named eventName.
Returns the number of listeners listening to the event named eventName.
emitter.listenerCount(eventName)
Returns a copy of the array of listeners for the event named eventName.
Returns a copy of the array of listeners for the event named eventName.
emitter.listeners(eventName)
Adds the listener function to the end of the listeners array for the event named eventName.
Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.
Returns a reference to the EventEmitter so calls can be chained.
emitter.on(eventName, listener)
Adds a one time listener function for the event named eventName.
Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.
emitter.once(eventName, listener)
The path to the file the stream is writing to as specified in the first argument to fs.createWriteStream().
The path to the file the stream is writing to as specified in the first argument to fs.createWriteStream(). If path is passed as a string, then writeStream.path will be a string. If path is passed as a Buffer, then writeStream.path will be a Buffer.
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
emitter.removeAllListeners([eventName])
Removes all listeners, or those of the specified eventName.
Removes all listeners, or those of the specified eventName.
Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter so calls can be chained.
emitter.removeAllListeners([eventName])
Removes the specified listener from the listener array for the event named eventName.
Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.
Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.
emitter.removeListener(eventName, listener)
Sets the default encoding for a writable stream.
Sets the default encoding for a writable stream.
writable.setDefaultEncoding(encoding)
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.
By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter so calls can be chained.
emitter.setMaxListeners(n)
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
writable.uncork()
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
The data to write (<String> | <Buffer>)
The encoding, if chunk is a String
the Callback for when this chunk of data is flushed
true, if the data was handled completely
writable.write(chunk[, encoding][, callback])
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
The data to write (<String> | <Buffer>)
The encoding, if chunk is a String
true, if the data was handled completely
writable.write(chunk[, encoding][, callback])
Flush all data, buffered since stream.cork() call.
Flush all data, buffered since stream.cork() call.
The data to write (<String> | <Buffer>)
the Callback for when this chunk of data is flushed
true, if the data was handled completely
writable.write(chunk[, encoding][, callback])
fs.WriteStream - WriteStream is a Writable Stream.
https://nodejs.org/api/fs.html#fs_class_fs_writestream