Socket
Socket
Sign inDemoInstall

rmfr

Package Overview
Dependencies
5
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    rmfr

Node.js implementation of `rm -fr` – recursive removal of files and directories


Version published
Weekly downloads
45K
decreased by-2.92%
Maintainers
1
Install size
279 kB
Created
Weekly downloads
 

Readme

Source

rmfr

npm version Build Status Build status Coverage Status

Node.js implementation of rm -fr – recursive removal of files and directories

const rmfr = require('rmfr');

(async () => await rmfr('path/to/target'))();

Installation

Use npm.

npm install rmfr

API

const rmfr = require('rmfr');

rmfr(path [, options])

path: string (a file/directory path)
options: Object
Return: Promise

When it finish removing a target, it will be fulfilled with no arguments.

When it fails to remove a target, it will be rejected with an error as its first argument.

Options

All rimraf options except for disableGlob are available, with some differences:

  • glob option defaults to false.
  • unlink, chmod, rmdir and readdir options default to the corresponding graceful-fs methods.
const rmfr = require('rmfr');

rmfr('inde*.js'); // doesn't remove `./index.js`
rmfr('inde*.js', {glob: true}); // removes `./index.js`

License

ISC License © 2017 - 2018 Shinnosuke Watanabe

Keywords

FAQs

Last updated on 02 Mar 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc