1
0
Fork 0
mirror of https://github.com/shimataro/ssh-key-action.git synced 2025-06-19 22:52:10 +10:00
ssh-key-action/node_modules/fs-write-stream-atomic
2019-09-18 20:39:54 +09:00
..
test * first action! (#1) 2019-09-18 20:39:54 +09:00
.npmignore * first action! (#1) 2019-09-18 20:39:54 +09:00
.travis.yml * first action! (#1) 2019-09-18 20:39:54 +09:00
index.js * first action! (#1) 2019-09-18 20:39:54 +09:00
LICENSE * first action! (#1) 2019-09-18 20:39:54 +09:00
package.json * first action! (#1) 2019-09-18 20:39:54 +09:00
README.md * first action! (#1) 2019-09-18 20:39:54 +09:00

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'