odin-default-js-exercises/node_modules/write
Cody Loyd 834d78b8b2 remove timer and simon 2017-12-15 12:56:14 -06:00
..
LICENSE remove timer and simon 2017-12-15 12:56:14 -06:00
README.md remove timer and simon 2017-12-15 12:56:14 -06:00
index.js remove timer and simon 2017-12-15 12:56:14 -06:00
package.json remove timer and simon 2017-12-15 12:56:14 -06:00

README.md

write NPM version Build Status

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

Install with npm

$ npm i write --save

API docs

writeFile

Asynchronously write a file to disk. Creates any intermediate directories 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. Creates any intermediate directories 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 if they don't already exist.

Params

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

Example

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

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.


This file was generated by verb-cli on July 29, 2015.