@supercharge/fs
v3.4.2
Published
Async filesystem methods for Node.js
Downloads
32,872
Readme
Introduction
The @supercharge/fs
package provides an improved and extended fs
implementation
- provides convenience methods like
isFile(path)
orisDirectory(path)
- useful methods, like
copy
,ensureFile
,ensureDir
- based on fs-extra providing all native
fs
methods from Node.js - full async/await support
- aligned camelCase method naming, like
realPath
instead ofrealpath
Installation
npm i @supercharge/fs
Resources
Quick Usage Overview
Using @supercharge/fs
is pretty straightforward. Install and import the package in your project and use the methods to interact with the filesystem.
For example, you may copy or move a file from src
to dest
or retrieve a file’s size:
const Fs = require('@supercharge/fs')
await Fs.copy(src, dest)
await Fs.move(src, dest)
const size = await Fs.size(file)
// 3758 bytes
Have a look at the docs for this package to find more details on all supported methods.
Contributing
Do you miss a string function? We very much appreciate your contribution! Please send in a pull request 😊
- Create a fork
- Create your feature branch:
git checkout -b my-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request 🚀
License
MIT © Supercharge
superchargejs.com · GitHub @supercharge · Twitter @superchargejs