del

Functions

• deleteAsync()
• deleteSync()

Type Aliases

• Options
• ProgressData

function deleteAsync

deleteAsync: (
    patterns: string | readonly string[],
    options?: Options
) => Promise<string[]>;

• Delete files and directories using glob patterns.

  Note that glob patterns can only contain forward-slashes, not backward-slashes. Windows file paths can use backward-slashes as long as the path does not contain any glob-like characters, otherwise use path.posix.join() instead of path.join().

  For each group of positive patterns, del looks inside the matched directories twice to find what was left out, with and without the exclusions that follow that group. A later positive pattern can bring back a directory and its contents. These scans always recurse and include dot files, regardless of deep, dot, or globstar, so they also walk excluded directories like a large node_modules. They only run when there is an exclusion.

  If a deletion fails, no new fs.rm calls are started, and the promise rejects with the first error once the already-started fs.rm calls have settled. Node.js may continue deleting children of a directory after its recursive fs.rm call rejects.

  Parameter patterns

  See the supported [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns). - [Pattern examples with expected matches](https://github.com/sindresorhus/multimatch/blob/main/test/test.js) - [Quick globbing pattern overview](https://github.com/sindresorhus/multimatch#globbing-patterns)

  Parameter options

  You can specify any of the [globby options](https://github.com/sindresorhus/globby#options) in addition to the del options, except objectMode and stats, which return entries instead of paths. In contrast to the globby defaults, expandDirectories, onlyFiles, followSymbolicLinks, and expandNegationOnlyPatterns are false by default.

  Returns

  The deleted paths.

  Example 1

  import {deleteAsync} from 'del';
  
  const deletedPaths = await deleteAsync(['temp/*.js', '!temp/unicorn.js']);
  
  console.log('Deleted files and directories:\n', deletedPaths.join('\n'));

function deleteSync

deleteSync: (
    patterns: string | readonly string[],
    options?: Options
) => string[];

• Synchronously delete files and directories using glob patterns.

  Note that glob patterns can only contain forward-slashes, not backward-slashes. Windows file paths can use backward-slashes as long as the path does not contain any glob-like characters, otherwise use path.posix.join() instead of path.join().

  For each group of positive patterns, del looks inside the matched directories twice to find what was left out, with and without the exclusions that follow that group. A later positive pattern can bring back a directory and its contents. These scans always recurse and include dot files, regardless of deep, dot, or globstar, so they also walk excluded directories like a large node_modules. They only run when there is an exclusion.

  Parameter patterns

  See the supported [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns). - [Pattern examples with expected matches](https://github.com/sindresorhus/multimatch/blob/main/test/test.js) - [Quick globbing pattern overview](https://github.com/sindresorhus/multimatch#globbing-patterns)

  Parameter options

  You can specify any of the [globby options](https://github.com/sindresorhus/globby#options) in addition to the del options, except objectMode and stats, which return entries instead of paths. In contrast to the globby defaults, expandDirectories, onlyFiles, followSymbolicLinks, and expandNegationOnlyPatterns are false by default.

  Returns

  The deleted paths.

type Options

type Options = {
    /**
	Allow deleting the current working directory and outside.

	@default false
	*/
    readonly force?: boolean;

    /**
	See what would be deleted.

	@default false

	@example
	```
	import {deleteAsync} from 'del';

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

	console.log('Files and directories that would be deleted:\n', deletedPaths.join('\n'));
	```
	*/
    readonly dryRun?: boolean;

    /**
	Concurrency limit. `deleteAsync` applies it to the deletions and, through globby, to how many directories are read at once. `deleteSync` deletes one path at a time and globby reads synchronously, so the option has no effect there. Minimum: `1`.

	The paths are ordered so that a directory is removed after the paths inside it, but that order only holds as far as `concurrency` reaches, so with `followSymbolicLinks: true` a symlink that is the only route to its target can leave files behind. Use `1` if that matters.

	@default `256` for the deletions, `os.cpus().length` for the directory reads
	*/
    readonly concurrency?: number;

    /**
	The directory the patterns are relative to, and the boundary that `del` refuses to delete outside of without `force`.

	Only the process working directory and the directories above it are protected no matter what this is set to, so a `cwd` elsewhere moves the boundary with it.

	@default process.cwd()

	@example
	```
	import {deleteSync} from 'del';

	// Deletes `dist` and everything in it, without touching anything above it.
	deleteSync('dist', {cwd: '/var/www/app'});
	```
	*/
    readonly cwd?: string;

    /**
	Called after each file or directory is deleted, and once with no `path` when there is nothing to delete.

	@example
	```
	import {deleteAsync} from 'del';

	await deleteAsync(patterns, {
		onProgress: progress => {
		// …
	}});
	```
	*/
    readonly onProgress?: (progress: ProgressData) => void;
} & Omit<GlobbyOptions, 'cwd' | 'objectMode' | 'stats'>;

type ProgressData

type ProgressData = {
    /**
	Deleted files and directories count, or the count of what the `dryRun` option would have deleted.
	*/
    readonly deletedCount: number;

    /**
	Total files and directories count.
	*/
    readonly totalCount: number;

    /**
	Completed percentage. A value between `0` and `1`.
	*/
    readonly percent: number;

    /**
	The absolute path of the deleted file or directory, or the one the `dryRun` option would have deleted.

	It is not present when there is nothing to delete, which is the only time the report has no `path`.
	*/
    readonly path?: string;
};