write-file-atomic 1.2.0

The npm package "write-file-atomic" works as an extension to Node.js' fs.writeFile and introduces the ability to write data to a file atomically, with configurable file ownership. The way it functions is by writing data to a temporary file and then renaming it to the desired file name once the operation is complete. This ensures the operation is atomic and improves data integrity by guaranteeing that the file will not be in a corrupted or incomplete state even if an error or process interruption occurs during writing. It also allows for setting user and group ownership (UID/GID) of the file.

To use write-file-atomic, start by installing it using npm. Once installed, it can be required at the top of your JavaScript file using the following syntax: var writeFileAtomic = require('write-file-atomic'). Now, to write data to a file atomically, use the following syntax:

writeFileAtomic('filename.txt', 'Data to write', {chown:{uid:100,gid:50}}, function (err) {
  if (err) throw err;
  console.log('File has been saved!');
});

Alternatively, this package also supports the async/await syntax. The equivalent async/await code would be:

(async () => {
  try {
    await writeFileAtomic('filename.txt', 'Data to write', {chown:{uid:100,gid:50}});
    console.log('File has been saved!');
  } catch (err) {
    console.error(err);
    process.exit(1);
  }
})();

It also exposes a synchronous version of the writeFileAtomic function which can be used as follows:

var writeFileAtomicSync = require('write-file-atomic').sync;
writeFileAtomicSync('filename.txt', 'Data to write', {chown:{uid:100,gid:50}});

The documentation for write-file-atomic isn't separate and presented elsewhere, but can be found within the README.md file on the package's GitHub repository here. It includes descriptions of its functionality, usage, and a list of configurable options.