Fs

Extended drop-in fs replacement for Node.js

Follow @marcuspoehls and @superchargejs for updates!

--- ## Introduction The `@supercharge/fs` package provides an improved and extended [`fs`](https://nodejs.org/dist/latest-v12.x/docs/api/fs.html) implementation - provides convenience methods like `isFile(path)` or `isDirectory(path)` - useful methods, like `copy`, `ensureFile`, `ensureDir` - based on [fs-extra](https://github.com/jprichardson/node-fs-extra) providing all native `fs` methods from Node.js - full async/await support - aligned camelCase method naming, like `realPath` instead of `realpath` ## Installation ``` npm i @supercharge/fs ``` ## Resources - [Documentation](https://superchargejs.com/docs/filesystem) ## 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: ```js 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](https://superchargejs.com/docs/filesystem) 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 😊 1. Create a fork 2. Create your feature branch: `git checkout -b my-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 MIT © [Supercharge](https://superchargejs.com) --- > [superchargejs.com](https://superchargejs.com) · > GitHub [@supercharge](https://github.com/supercharge/) · > Twitter [@superchargejs](https://twitter.com/superchargejs)