1 | # Installation
|
2 | > `npm install --save @types/rimraf`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for rimraf (https://github.com/isaacs/rimraf).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rimraf.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/rimraf/index.d.ts)
|
10 | ````ts
|
11 | // Type definitions for rimraf 3.0
|
12 | // Project: https://github.com/isaacs/rimraf
|
13 | // Definitions by: Carlos Ballesteros Velasco <https://github.com/soywiz>
|
14 | // e-cloud <https://github.com/e-cloud>
|
15 | // Ruben Schmidmeister <https://github.com/bash>
|
16 | // Oganexon <https://github.com/oganexon>
|
17 | // Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
18 | // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
19 |
|
20 | /// <reference types="node" />
|
21 |
|
22 | import glob = require('glob');
|
23 | import fs = require('fs');
|
24 |
|
25 | declare function rimraf(path: string, options: rimraf.Options, callback: (error: Error | null | undefined) => void): void;
|
26 | declare function rimraf(path: string, callback: (error: Error | null | undefined) => void): void;
|
27 | declare namespace rimraf {
|
28 | /**
|
29 | * It can remove stuff synchronously, too.
|
30 | * But that's not so good. Use the async API.
|
31 | * It's better.
|
32 | */
|
33 | function sync(path: string, options?: Options): void;
|
34 |
|
35 | /**
|
36 | * see {@link https://github.com/isaacs/rimraf/blob/79b933fb362b2c51bedfa448be848e1d7ed32d7e/README.md#options}
|
37 | */
|
38 | interface Options {
|
39 | maxBusyTries?: number | undefined;
|
40 | emfileWait?: number | undefined;
|
41 | /** @default false */
|
42 | disableGlob?: boolean | undefined;
|
43 | glob?: glob.IOptions | false | undefined;
|
44 |
|
45 | unlink?: typeof fs.unlink | undefined;
|
46 | chmod?: typeof fs.chmod | undefined;
|
47 | stat?: typeof fs.stat | undefined;
|
48 | lstat?: typeof fs.lstat | undefined;
|
49 | rmdir?: typeof fs.rmdir | undefined;
|
50 | readdir?: typeof fs.readdir | undefined;
|
51 | unlinkSync?: typeof fs.unlinkSync | undefined;
|
52 | chmodSync?: typeof fs.chmodSync | undefined;
|
53 | statSync?: typeof fs.statSync | undefined;
|
54 | lstatSync?: typeof fs.lstatSync | undefined;
|
55 | rmdirSync?: typeof fs.rmdirSync | undefined;
|
56 | readdirSync?: typeof fs.readdirSync | undefined;
|
57 | }
|
58 | }
|
59 | export = rimraf;
|
60 |
|
61 | ````
|
62 |
|
63 | ### Additional Details
|
64 | * Last updated: Wed, 18 Aug 2021 21:01:23 GMT
|
65 | * Dependencies: [@types/glob](https://npmjs.com/package/@types/glob), [@types/node](https://npmjs.com/package/@types/node)
|
66 | * Global values: none
|
67 |
|
68 | # Credits
|
69 | These definitions were written by [Carlos Ballesteros Velasco](https://github.com/soywiz), [e-cloud](https://github.com/e-cloud), [Ruben Schmidmeister](https://github.com/bash), [Oganexon](https://github.com/oganexon), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).
|
70 |
|
\ | No newline at end of file |