write

What is write?

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.

What are write's main functionalities?

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);

Other packages similar to write

fs-extra

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

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.

README

write

Write files to disk, creating intermediate directories if they don't exist.

Install

Install with npm:

$ npm install --save write

Usage

var writeFile = require('write');

API

writeFile

Asynchronously write a file to disk, creating any intermediate directories along the way if they don't already exist.

Params

• dest {String}: Destination file path
• str {String}: String to write to disk.
• callback {Function}

Example

var writeFile = require('write');
writeFile('foo.txt', 'This is content to write.', function(err) {
  if (err) console.log(err);
});

.writeFile.sync

Synchronously write files to disk, creating any intermediate directories along the way if they don't already exist.

Params

• dest {String}: Destination file path
• str {String}: String to write to disk.

Example

var writeFile = require('write');
writeFile.sync('foo.txt', 'This is content to write.');

.writeFile.stream

Uses fs.createWriteStream, but also creates any intermediate directories along the way if they don't already exist.

Params

• dest {String}: Destination file path
• returns {Stream}: Returns a write stream.

Example

var writeFile = require('write');
writeFile.stream('foo.txt');

About

Related projects

• delete: Delete files and folders and any intermediate directories if they exist (sync and async). | homepage
• read-data: Read JSON or YAML files. | homepage
• read-json: Reads and parses a JSON file. | homepage
• read-yaml: Very thin wrapper around js-yaml for directly reading in YAML files. | homepage
• write-json: Write a JSON file to disk, also creates intermediate directories in the destination path if… more | homepage
• write-yaml: Write YAML. Converts JSON to YAML writes it to the specified file. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Contributors

Commits	Contributor
22	jonschlinkert
1	tunnckoCore

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

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

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.4.3, on March 24, 2017.