1.0.0 • Published 6 years ago

write-file-tree v1.0.0

Weekly downloads
5
License
Apache-2.0
Repository
github
Last release
6 years ago

write-file-tree

write an object to nested file tree, with one file for each value

npm travis standard

Install

npm install write-file-tree

Usage

var writeFileTree = require('write-file-tree')

writeFileTree('/path/to/directory', {
  'index.html': '<!DOCTYPE html><html>...',
  'bundle.js': getMyBundle()
}, function (err) {
  if (err) console.error('failed')
})

API

writeFileTree(basedir, tree[, opts], cb)

Recursively write each value in the tree object to a directory basedir. opts can be an object:

  • opts.encoding - encoding to pass to fs.writeFile()
  • opts.limit - max amount of i/o operations to run simultaneously. default 5.

cb is a node-style callback receiving an error in the first parameter. Object keys in the tree object are file names, while values are the file contents. Nested directories have another tree object as their value. For example, the test/fixture directory can be written by using this object:

writeFileTree('test/fixture', {
  'one.js': '1;\n',
  'two.js': '2;\n',
  a: {
    b: {
      'c.txt': 'this is c\n',
      c: {
        'd.txt': 'file d\n' } } }
}, cb)

writeFileTree.sync(basedir, tree[, opts])

The same, but sync.

License

Apache-2.0