You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
84 lines
2.9 KiB
84 lines
2.9 KiB
import {GlobbyOptions} from 'globby'; |
|
|
|
declare namespace del { |
|
interface Options extends GlobbyOptions { |
|
/** |
|
Allow deleting the current working directory and outside. |
|
|
|
@default false |
|
*/ |
|
readonly force?: boolean; |
|
|
|
/** |
|
See what would be deleted. |
|
|
|
@default false |
|
|
|
@example |
|
``` |
|
import 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')); |
|
})(); |
|
``` |
|
*/ |
|
readonly dryRun?: boolean; |
|
|
|
/** |
|
Concurrency limit. Minimum: `1`. |
|
|
|
@default Infinity |
|
*/ |
|
readonly concurrency?: number; |
|
} |
|
} |
|
|
|
declare const del: { |
|
/** |
|
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()`. |
|
|
|
@param patterns - See the supported [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns). |
|
- [Pattern examples with expected matches](https://github.com/sindresorhus/multimatch/blob/master/test/test.js) |
|
- [Quick globbing pattern overview](https://github.com/sindresorhus/multimatch#globbing-patterns) |
|
@param options - You can specify any of the [`globby` options](https://github.com/sindresorhus/globby#options) in addition to the `del` options. In contrast to the `globby` defaults, `expandDirectories`, `onlyFiles`, and `followSymbolicLinks` are `false` by default. |
|
@returns The deleted paths. |
|
*/ |
|
sync: ( |
|
patterns: string | readonly string[], |
|
options?: del.Options |
|
) => 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()`. |
|
|
|
@param patterns - See the supported [glob patterns](https://github.com/sindresorhus/globby#globbing-patterns). |
|
- [Pattern examples with expected matches](https://github.com/sindresorhus/multimatch/blob/master/test/test.js) |
|
- [Quick globbing pattern overview](https://github.com/sindresorhus/multimatch#globbing-patterns) |
|
@param options - You can specify any of the [`globby` options](https://github.com/sindresorhus/globby#options) in addition to the `del` options. In contrast to the `globby` defaults, `expandDirectories`, `onlyFiles`, and `followSymbolicLinks` are `false` by default. |
|
@returns The deleted paths. |
|
|
|
@example |
|
``` |
|
import del = require('del'); |
|
|
|
(async () => { |
|
const deletedPaths = await del(['temp/*.js', '!temp/unicorn.js']); |
|
|
|
console.log('Deleted files and directories:\n', deletedPaths.join('\n')); |
|
})(); |
|
``` |
|
*/ |
|
( |
|
patterns: string | readonly string[], |
|
options?: del.Options |
|
): Promise<string[]>; |
|
}; |
|
|
|
export = del;
|
|
|