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.
The 'write' npm package is a simple utility for writing data to files. It provides a straightforward API for writing strings or buffers to a file, with options to specify encoding, mode, and flag. It's designed to make file writing tasks in Node.js applications easier and more efficient.
Write string to file
This feature allows you to write a string directly to a file. The example shows how to synchronously write 'Hello World' to 'file.txt'.
const write = require('write');
write.sync('file.txt', 'Hello World');Write buffer to file
This feature enables writing buffer data to a file. The code sample demonstrates writing a buffer containing 'Hello World' to 'file.txt'.
const write = require('write');
const buffer = Buffer.from('Hello World', 'utf8');
write.sync('file.txt', buffer);Write string to file asynchronously
This feature supports asynchronous file writing. The example illustrates how to write 'Hello World' to 'file.txt' and log a message upon completion.
const write = require('write');
write('file.txt', 'Hello World').then(() => console.log('Write complete')).catch(console.error);fs-extra is a package that builds on the Node.js fs module, providing additional methods not found in the standard library. It includes file writing capabilities similar to 'write', but also offers a wide range of file system operations, making it more versatile.
write-file-atomic is similar to 'write' in that it focuses on writing files, but it adds atomic writing capabilities. This means it writes to a temporary file before renaming it to the target filename, which can prevent data corruption in case of a write failure.
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 with npm (requires Node.js >=10):
$ npm install --save write
const write = require('write');
The following options may be used with any method.
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 });
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 });
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"
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
filepath {String}: file path.options {Object}: Options to pass to fs.createWriteStreamreturns {Stream}: Returns a new WriteStream object. (See Writable Stream).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
});
See [CHANGELOG.md].
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
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
(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
You might also be interested in these projects:
| Commits | Contributor |
|---|---|
| 42 | jonschlinkert |
| 2 | jpetitcolas |
| 1 | tunnckoCore |
Jon Schlinkert
Copyright © 2019, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on September 04, 2019.
v2.0.0 - 2019-08-12
Changes
fs.createWriteStream in the main function to improve performance.Added
overwrite optionincrement optionSee the README for more details.
Removed
options.newline. This should be done before passing the contents to write().promise method was removed since the main export returns a promise, making the method unnecessary.FAQs
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.
The npm package write receives a total of 3,086,548 weekly downloads. As such, write popularity was classified as popular.
We found that write demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A survey of 500 cybersecurity pros reveals high pay isn't enough—lack of growth and flexibility is driving attrition and risking organizational security.
Product
Socket, the leader in open source security, is now available on Google Cloud Marketplace for simplified procurement and enhanced protection against supply chain attacks.
Security News
Corepack will be phased out from future Node.js releases following a TSC vote.