write-to-file

1.0.2 • Public • Published

Write to File

Build Status Test Covarage Greenkeeper Latest Version

Writes data to file and automatically create its directories if not exists.

Installation

$ npm install write-to-file

Usage

const writeToFile = require("write-to-file");
 
(async () => {
  try {
    await writeToFile("foo/bar/baz.txt", "Hello World!");
  } catch(error) {
    console.error(error.message);
  }
})();

If foo/bar directory does not exist, it will be created automatically.

Recipes

Set the Character Encoding

You can pass the character encoding as the third argument. Default to utf8.

const writeToFile = require("write-to-file");
 
(async () => {
  const buff = Buffer.from("Hello World!");
 
  try {
    await writeToFile("foo.txt", buff.toString("hex"), "hex");
  } catch(error) {
    console.error(error.message);
  }
})();

You can also pass an object:

writeToFile("foo.txt", buff.toString("hex"), {
  encoding: "hex"
});

Appending Data to a File

By default, if the file already exists, it will be overwritten. For appending data to a file, you may pass the flag option:

const writeToFile = require("write-to-file");
 
(async () => {
  try {
    await writeToFile("foo.txt", "bar", {
      flag: "a"
    });
  } catch(error) {
    console.error(error.message);
  }
})();

API

writeToFile(file, data, [options])

Parameters

  • file (String): The file path to write to.
  • data (String|Buffer): Data to write.
  • options (Optional Object|String): You may pass the encoding as the third argument. You may also pass an object:
    • encoding (String): The character encoding to use, default to utf8.
    • mode (Number): The file permission to set, default to 0o666.
    • flag (String): The file system flag, default to w.
    • createDirMode (Number): The directory permission to set when creating the parent directory that does not exist, default to 0o777.

Returns

It returns a Promise which when resolved contains a true value.

Related

  • create-dir: Module to create directory recursively.

License

MIT © Risan Bagja Pradana

Readme

Keywords

Package Sidebar

Install

npm i write-to-file

Weekly Downloads

63

Version

1.0.2

License

MIT

Unpacked Size

6.32 kB

Total Files

4

Last publish

Collaborators

  • risan