fs-atomic

Safer filesystem operations.

Usage no npm install needed!

<script type="module">
  import fsAtomic from 'https://cdn.skypack.dev/fs-atomic';
</script>

README

fs-atomic Build status for fs-atomic on Circle CI.

Safer filesystem operations.

Why?

  • Protects you from race conditions.
  • Protects you from making some security mistakes.
  • Automatically creates nested directories as needed.
  • Always overwrites, avoiding EEXIST errors.

Install

npm install fs-atomic --save

Usage

Get it into your program.

const fsAtomic = require('fs-atomic');

Create nested directories.

fsAtomic.mkdir('nonexisting/thing', 'another/one').then(() => {
    console.log('Directories created.');
});

Create a symlink.

fsAtomic.symlink('mytarget', '/my/dest').then(() => {
    console.log('Symlinking complete.');
});

Write a file.

fsAtomic.writeFile('myfile', 'some data').then(() => {
    console.log('Write complete.');
});

Contributing

See our contributing guidelines for more details.

  1. Fork it.
  2. Make a feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.