Palak Handa / startUpJalsa-Backend

Blame view

node_modules/del/readme.md 2.37 KB
edit raw normal view history
f7563de62   Palak Handa   first commit 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
  # del [![Build Status](https://travis-ci.org/sindresorhus/del.svg?branch=master)](https://travis-ci.org/sindresorhus/del)
  
  > Delete files and folders using [globs](https://github.com/isaacs/minimatch#usage)
  
  Pretty much [rimraf](https://github.com/isaacs/rimraf) with a Promise API and support for multiple files and globbing. It also protects you against deleting the current working directory and above.
  
  ---
  
  <p align="center"><b>🔥 Want to strengthen your core JavaScript skills and master ES6?</b><br>I would personally recommend this awesome <a href="https://ES6.io/friend/AWESOME">ES6 course</a> by Wes Bos.</p>
  
  ---
  
  
  ## Install
  
  ```
  $ npm install --save del
  ```
  
  
  ## Usage
  
  ```js
  const del = require('del');
  
  del(['tmp/*.js', '!tmp/unicorn.js']).then(paths => {
  	console.log('Deleted files and folders:
  ', paths.join('
  '));
  });
  ```
  
  
  ## Beware
  
  The glob pattern `**` matches all children and *the parent*.
  
  So this won't work:
  
  ```js
  del.sync(['public/assets/**', '!public/assets/goat.png']);
  ```
  
  You have to explicitly ignore the parent directories too:
  
  ```js
  del.sync(['public/assets/**', '!public/assets', '!public/assets/goat.png']);
  ```
  
  Suggestions on how to improve this welcome!
  
  
  ## API
  
  ### del(patterns, [options])
  
  Returns a promise for an array of deleted paths.
  
  ### del.sync(patterns, [options])
  
  Returns an array of deleted paths.
  
  #### patterns
  
  Type: `string`, `array`
  
  See supported minimatch [patterns](https://github.com/isaacs/minimatch#usage).
  
  - [Pattern examples with expected matches](https://github.com/sindresorhus/multimatch/blob/master/test.js)
  - [Quick globbing pattern overview](https://github.com/sindresorhus/multimatch#globbing-patterns)
  
  #### options
  
  Type: `object`
  
  See the `node-glob` [options](https://github.com/isaacs/node-glob#options).
  
  ##### force
  
  Type: `boolean`  
  Default: `false`
  
  Allow deleting the current working directory and outside.
  
  ##### dryRun
  
  Type: `boolean`  
  Default: `false`
  
  See what would be deleted.
  
  ```js
  const del = require('del');
  
  del(['tmp/*.js'], {dryRun: true}).then(paths => {
  	console.log('Files and folders that would be deleted:
  ', paths.join('
  '));
  });
  ```
  
  
  ## CLI
  
  See [del-cli](https://github.com/sindresorhus/del-cli) for a CLI for this module and [trash-cli](https://github.com/sindresorhus/trash-cli) for a safe version that is suitable for running by hand.
  
  
  ## License
  
  MIT © [Sindre Sorhus](http://sindresorhus.com)