write 
Write data to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Thin wrapper around node's native fs methods.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.
Install
Install with npm (requires Node.js >=10):
$ npm install --save write
Usage
const write = require('write');
Options
The following options may be used with any method.
options.newline
Type: boolean
Default: undefined
Ensure that contents has a trailing newline before writing it to the file system.
write.sync('foo.txt', 'some data...', { newline: true });
options.overwrite
Type: boolean
Default: undefined
Set to false to prevent existing files from being overwritten. See increment for a less severe alternative.
write.sync('foo.txt', 'some data...', { overwrite: false });
options.increment
Type: boolean
Default: undefined
Set to true to automatically rename files by appending an increment, like foo (2).txt, to prevent foo.txt from being overwritten. This is useful when writing log files, or other information where the file name is less important than the contents being written.
write.sync('foo.txt', 'some data...', { increment: true });
// if "foo.txt" exists, the file will be renamed to "foo (2).txt"
API
Asynchronously writes data to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Data can be a string or a buffer. Returns a promise if a callback function is not passed.
Params
filepath {String}: file path.data {String|Buffer|Uint8Array}: Data to write.options {Object}: Options to pass to fs.writeFilecallback {Function}: (optional) If no callback is provided, a promise is returned.returns {Object}: Returns an object with the path and contents of the file that was written to the file system. This is useful for debugging when options.increment is used and the path might have been modified.
Example
const write = require('write');
// async/await
(async () => {
await write('foo.txt', 'This is content...');
})();
// promise
write('foo.txt', 'This is content...')
.then(() => {
// do stuff
});
// callback
write('foo.txt', 'This is content...', err => {
// do stuff with err
});
The synchronous version of write. Returns undefined.
Params
filepath {String}: file path.data {String|Buffer|Uint8Array}: Data to write.options {Object}: Options to pass to fs.writeFileSyncreturns {Object}: Returns an object with the path and contents of the file that was written to the file system. This is useful for debugging when options.increment is used and the path might have been modified.
Example
const write = require('write');
write.sync('foo.txt', 'This is content...');
Returns a new WriteStream object. Uses fs.createWriteStream to write data to a file, replacing the file if it already exists and creating any intermediate directories if they don't already exist. Data can be a string or a buffer.
Params
Example
const fs = require('fs');
const write = require('write');
fs.createReadStream('README.md')
.pipe(write.stream('a/b/c/other-file.md'))
.on('close', () => {
// do stuff
});
Release history
See [CHANGELOG.md].
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Related projects
You might also be interested in these projects:
Contributors
Author
Jon Schlinkert
License
Copyright © 2019, Jon Schlinkert.
Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on September 04, 2019.
