Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on Feb 4, 2024 via pnpm

rimraf 3.0.2

A deep deletion module for node (like `rm -rf`)
Package summary
Share
0
issues
2
licenses
8
ISC
4
MIT
Package created
8 Feb 2011
Version published
9 Feb 2020
Maintainers
1
Total deps
12
Direct deps
1
License
ISC

Issues

0
This package has no issues

Licenses

ISC License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
Cannot
hold-liable
Must
include-copyright
include-license
8 Packages, Including:
fs.realpath@1.0.0
glob@7.2.3
inflight@1.0.6
inherits@2.0.4
minimatch@3.1.2
once@1.4.0
rimraf@3.0.2
wrappy@1.0.2

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
4 Packages, Including:
balanced-match@1.0.2
brace-expansion@1.1.11
concat-map@0.0.1
path-is-absolute@1.0.1
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

1
All Dependencies CSV
β“˜ This is a list of rimraf 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
glob7.2.315.08 kBISC
prod

Visualizations

Frequently Asked Questions

What does rimraf do?

Rimraf is a deep deletion module for node, similar to the UNIX command 'rm -rf'. It's designed to effectively and efficiently remove files and directories, overcoming challenges presented by different operating systems like Windows and UNIX-based platforms. Offering flexibility, the rimraf module can execute operations via a native implementation (default) or Windows implementation.

How do you use rimraf?

To use rimraf, you first need to install it with npm using the command npm install rimraf. Following this, you can import the required functions from the rimraf package using either import or require().

Here are some examples of how to use rimraf:

  1. Importing the functions:
// Using import
import { rimraf, rimrafSync, native, nativeSync } from 'rimraf'

// Using require()
const { rimraf, rimrafSync, native, nativeSync } = require('rimraf')
  1. Using the rimraf function to delete a path or an array of paths:
rimraf('/path/to/delete', options).then(success => console.log(success));
  1. Using the synchronous version of rimraf:
const success = rimrafSync('/path/to/delete', options);
console.log(success);

Options can be passed to define the behavior of the rimraf function, such as preserveRoot, tmp, maxRetries, backoff, and maxBackoff.

Where are the rimraf docs?

The documentation for rimraf can be found in its GitHub repository, at git://github.com/isaacs/rimraf.git. The readme file included in the repository provides a detailed explanation of the module's functionality, its API, configuration options, and various implementations. It also includes the major changes in the different versions of the module. The repository is the go-to source for developers seeking to understand and use rimraf effectively.