Write files to disk, by first creating intermediate directories if they don't exist, then passing through to 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 files to disk, by first creating intermediate directories if they don't exist, then passing through to node's native fs methods.
Install with npm:
$ npm install --save write
var writeFile = require('write');
Asynchronously write a file to disk, creating any intermediate directories first if they don't already exist.
Params
dest {String}: Destination file pathstr {String}: String to write to disk.options {Object}: Options to pass to fs.writeFile and mkdirpcallback {Function}: (optional) If no callback is provided, a promise is returned.Example
var writeFile = require('write');
writeFile('foo.txt', 'This is content to write.', function(err) {
if (err) console.log(err);
});
Synchronously write files to disk, creating any intermediate directories first if they don't already exist.
Params
dest {String}: Destination file pathval {String|Buffer}: String or buffer to write to disk.options {Object}: Options to pass to fs.writeFile and mkdirpExample
var writeFile = require('write');
writeFile.promise('foo.txt', 'This is content to write.')
.then(function() {
// do stuff
});
Synchronously write files to disk, creating any intermediate directories first if they don't already exist.
Params
dest {String}: Destination file pathval {String|Buffer}: String or buffer to write to disk.options {Object}: Options to pass to fs.writeFileSync and mkdirpExample
var writeFile = require('write');
writeFile.sync('foo.txt', 'This is content to write.');
Uses fs.createWriteStream, but also creates any intermediate directories first if they don't already exist.
Params
dest {String}: Destination file pathoptions {Object}: Options to pass to mkdirp and fs.createWriteStreamreturns {Stream}: Returns a write stream.Example
var fs = require('fs');
var writeFile = require('write');
fs.createReadStream('README.md')
.pipe(writeFile.stream('a/b/c/other-file.md'))
.on('close', function() {
// do stuff
});
Added
Changed
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
|---|---|
| 26 | jonschlinkert |
| 1 | tunnckoCore |
(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
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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 09, 2017.
v1.0.0 - 2017-07-09
Added
Changed
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,787,948 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
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.