diff options
Diffstat (limited to 'deps/npm/node_modules/update-notifier/node_modules/configstore/node_modules/write-file-atomic/README.md')
-rw-r--r-- | deps/npm/node_modules/update-notifier/node_modules/configstore/node_modules/write-file-atomic/README.md | 44 |
1 files changed, 0 insertions, 44 deletions
diff --git a/deps/npm/node_modules/update-notifier/node_modules/configstore/node_modules/write-file-atomic/README.md b/deps/npm/node_modules/update-notifier/node_modules/configstore/node_modules/write-file-atomic/README.md deleted file mode 100644 index a9d3461db1..0000000000 --- a/deps/npm/node_modules/update-notifier/node_modules/configstore/node_modules/write-file-atomic/README.md +++ /dev/null @@ -1,44 +0,0 @@ -write-file-atomic ------------------ - -This is an extension for node's `fs.writeFile` that makes its operation -atomic and allows you set ownership (uid/gid of the file). - -### var writeFileAtomic = require('write-file-atomic')<br>writeFileAtomic(filename, data, [options], callback) - -* filename **String** -* data **String** | **Buffer** -* options **Object** - * chown **Object** - * uid **Number** - * gid **Number** - * encoding **String** | **Null** default = 'utf8' - * mode **Number** default = 438 (aka 0666 in Octal) -callback **Function** - -Atomically and asynchronously writes data to a file, replacing the file if it already -exists. data can be a string or a buffer. - -The file is initially named `filename + "." + murmurhex(__filename, process.pid, ++invocations)`. -If writeFile completes successfully then, if passed the **chown** option it will change -the ownership of the file. Finally it renames the file back to the filename you specified. If -it encounters errors at any of these steps it will attempt to unlink the temporary file and then -pass the error back to the caller. - -If provided, the **chown** option requires both **uid** and **gid** properties or else -you'll get an error. - -The **encoding** option is ignored if **data** is a buffer. It defaults to 'utf8'. - -Example: - -```javascript -writeFileAtomic('message.txt', 'Hello Node', {chown:{uid:100,gid:50}}, function (err) { - if (err) throw err; - console.log('It\'s saved!'); -}); -``` - -### var writeFileAtomicSync = require('write-file-atomic').sync<br>writeFileAtomicSync(filename, data, [options]) - -The synchronous version of **writeFileAtomic**. |