Updating NPM dependencies
This commit is contained in:
22
node_modules/write-file-atomic/README.md
generated
vendored
22
node_modules/write-file-atomic/README.md
generated
vendored
@@ -4,7 +4,7 @@ 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)
|
||||
### var writeFileAtomic = require('write-file-atomic')<br>writeFileAtomic(filename, data, [options], [callback])
|
||||
|
||||
* filename **String**
|
||||
* data **String** | **Buffer**
|
||||
@@ -15,7 +15,7 @@ atomic and allows you set ownership (uid/gid of the file).
|
||||
* encoding **String** | **Null** default = 'utf8'
|
||||
* fsync **Boolean** default = true
|
||||
* mode **Number** default, from existing file, if any
|
||||
* Promise **Object** default = native Promise object
|
||||
* tmpfileCreated **Function** called when the tmpfile is created
|
||||
* callback **Function**
|
||||
|
||||
Atomically and asynchronously writes data to a file, replacing the file if it already
|
||||
@@ -27,7 +27,7 @@ If writeFile completes successfully then, if passed the **chown** option it will
|
||||
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 multiple writes are concurrently issued to the same file, the write operations are put into a queue and serialized in the order they were called, using Promises. Native promises are used by default, but you can inject your own promise-like object with the **Promise** option. Writes to different files are still executed in parallel.
|
||||
If multiple writes are concurrently issued to the same file, the write operations are put into a queue and serialized in the order they were called, using Promises. Writes to different files are still executed in parallel.
|
||||
|
||||
If provided, the **chown** option requires both **uid** and **gid** properties or else
|
||||
you'll get an error. If **chown** is not specified it will default to using
|
||||
@@ -42,6 +42,8 @@ If options is a String, it's assumed to be the **encoding** option. The **encodi
|
||||
|
||||
If the **fsync** option is **false**, writeFile will skip the final fsync call.
|
||||
|
||||
If the **tmpfileCreated** option is specified it will be called with the name of the tmpfile when created.
|
||||
|
||||
Example:
|
||||
|
||||
```javascript
|
||||
@@ -51,6 +53,20 @@ writeFileAtomic('message.txt', 'Hello Node', {chown:{uid:100,gid:50}}, function
|
||||
});
|
||||
```
|
||||
|
||||
This function also supports async/await:
|
||||
|
||||
```javascript
|
||||
(async () => {
|
||||
try {
|
||||
await writeFileAtomic('message.txt', 'Hello Node', {chown:{uid:100,gid:50}});
|
||||
console.log('It\'s saved!');
|
||||
} catch (err) {
|
||||
console.error(err);
|
||||
process.exit(1);
|
||||
}
|
||||
})();
|
||||
```
|
||||
|
||||
### var writeFileAtomicSync = require('write-file-atomic').sync<br>writeFileAtomicSync(filename, data, [options])
|
||||
|
||||
The synchronous version of **writeFileAtomic**.
|
||||
|
||||
Reference in New Issue
Block a user