del
    Overview
    Alternatives
    Playground
    Insights & Analysis
    Issues
    Versions
    Documentation
    Find an Expert
    Dependencies
    Career Opportunities
    Code

del

Delete files and directories

5.0.0  •  Published 2 months ago  •  by Sindre Sorhus  •  MIT License

Delete files and directories using globs

Similar to rimraf, but with a Promise API and support for multiple files and globbing. It also protects you against deleting the current working directory and above.

Install

$ npm install del

Usage

const del = require('del');

(async () => {
	const deletedPaths = await del(['temp/*.js', '!temp/unicorn.js']);

	console.log('Deleted files and directories:\n', deletedPaths.join('\n'));
})();

Beware

The glob pattern ** matches all children and the parent.

So this won’t work:

del.sync(['public/assets/**', '!public/assets/goat.png']);

You have to explicitly ignore the parent directories too:

del.sync(['public/assets/**', '!public/assets', '!public/assets/goat.png']);

Suggestions on how to improve this welcome!

API

del(patterns, options?)

Returns Promise<string[]> with the deleted paths.

del.sync(patterns, options?)

Returns string[] with the deleted paths.

patterns

Type: string | string[]

See the supported glob patterns.

options

Type: object

You can specify any of the globby options in addition to the below options. In constrast to the globby defaults, expandDirectories, onlyFiles, and followSymbolicLinks are false by default.

force

Type: boolean
Default: false

Allow deleting the current working directory and outside.

dryRun

Type: boolean
Default: false

See what would be deleted.

const del = require('del');

(async () => {
	const deletedPaths = await del(['temp/*.js'], {dryRun: true});

	console.log('Files and directories that would be deleted:\n', deletedPaths.join('\n'));
})();
concurrency

Type: number
Default: Infinity
Minimum: 1

Concurrency limit.

CLI

See del-cli for a CLI for this module and trash-cli for a safe version that is suitable for running by hand.

Related

  • make-dir - Make a directory and its parents if needed
  • globby - User-friendly glob matching

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Dependencies

globby  ·  is-path-cwd  ·  is-path-in-cwd  ·  p-map  ·  rimraf  ·  ava  ·  make-dir  ·  tempy  ·  tsd  ·  xo

Tags

delete
files
folders
directories
remove
destroy
trash
unlink
clean
cleaning
cleanup
rm
rmrf
rimraf
rmdir
glob
gulpfriendly
file
folder
directory
fs
filesystem
Get a weekly digest of your favorite packages
We track new versions of your favorite packages, read the changelogs, and summarize them - so you dont have to
Just $5/month per user

Popularity

Weekly Downloads
8.1M
Stars
992

Issues and PRs

Activity

Last ver 2 months ago
Created 5 years ago
Last commit 1 month ago
20 days between commits

Sustainability

15 contributors

Technology

Node version: 10.16.0
9.3K unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Top Experts

Sindre Sorhus
Maintainer, 73 commits, 16 merges
Chris Blossom
5 commits, 8 PRs
Kevin Mårtensson
Maintainer, 2 commits, 1 merges, 1 PRs
Works at imagemin yeoman
Michael Mayer
Maintainer, 3 commits, 3 PRs
Sam Verschueren
Maintainer, 1 commits, 1 merges, 1 PRs
Dimitri Benin
2 commits, 2 PRs