node/deps/npm/node_modules/fs-write-stream-atomic
Forrest L Norvell 938cc757bb deps: upgrade to npm 2.13.0
PR-URL: https://github.com/nodejs/io.js/pull/2152
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-07-16 12:26:54 -07:00
..
node_modules/graceful-fs deps: upgrade to npm 2.13.0 2015-07-16 12:26:54 -07:00
test deps: upgrade npm to 2.11.0 2015-05-30 08:15:11 -04:00
LICENSE npm: Upgrade to v2.1.6 2014-11-05 10:35:43 -08:00
README.md npm: Upgrade to v2.1.6 2014-11-05 10:35:43 -08:00
index.js deps: upgrade npm to 2.11.0 2015-05-30 08:15:11 -04:00
package.json deps: upgrade npm to 2.11.0 2015-05-30 08:15:11 -04:00

README.md

fs-write-stream-atomic

Like fs.createWriteStream(...), but atomic.

Writes to a tmp file and does an atomic fs.rename to move it into place when it's done.

First rule of debugging: It's always a race condition.

USAGE

var fsWriteStreamAtomic = require('fs-write-stream-atomic')
// options are optional.
var write = fsWriteStreamAtomic('output.txt', options)
var read = fs.createReadStream('input.txt')
read.pipe(write)

// When the write stream emits a 'finish' or 'close' event,
// you can be sure that it is moved into place, and contains
// all the bytes that were written to it, even if something else
// was writing to `output.txt` at the same time.

fsWriteStreamAtomic(filename, [options])

  • filename {String} The file we want to write to
  • options {Object}
    • chown {Object} User and group to set ownership after write
      • uid {Number}
      • gid {Number}
    • encoding {String} default = 'utf8'
    • mode {Number} default = 0666
    • flags {String} default = 'w'