Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

supercharge/fs

Repository files navigation



Fs

Extended drop-in fs replacement for Node.js


Installation · Docs · Usage



Latest Version Monthly downloads

Follow @marcuspoehls and @superchargejs for updates!


Introduction

The @supercharge/fs package provides an improved and extended fs implementation

  • provides convenience methods like isFile(path) or isDirectory(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 of realpath

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 😊

  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


superchargejs.com · GitHub @supercharge · Twitter @superchargejs

Packages

Contributors 3

AltStyle によって変換されたページ (->オリジナル) /