1 | filedel
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
13 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
14 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
15 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
16 |
|
17 | [bd_repo_url]: https://github.com/okunishinishi/node-filedel
|
18 | [bd_travis_url]: http://travis-ci.org/okunishinishi/node-filedel
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-filedel.svg?style=flat
|
20 | [bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-filedel
|
21 | [bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-filedel.svg?token=
|
22 | [bd_license_url]: https://github.com/okunishinishi/node-filedel/blob/master/LICENSE
|
23 | [bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-filedel
|
24 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-filedel.svg?style=flat
|
25 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-filedel.svg?style=flat
|
26 | [bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-filedel
|
27 | [bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-filedel.svg
|
28 | [bd_npm_url]: http://www.npmjs.org/package/filedel
|
29 | [bd_npm_shield_url]: http://img.shields.io/npm/v/filedel.svg?style=flat
|
30 | [bd_standard_url]: http://standardjs.com/
|
31 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 | <a name="description"></a>
|
38 |
|
39 | Delete files.
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 |
|
47 | <a name="sections"></a>
|
48 |
|
49 |
|
50 |
|
51 | <a name="section-doc-guides-01-installation-md"></a>
|
52 |
|
53 | Installation
|
54 | -----
|
55 |
|
56 | ```bash
|
57 | npm install filedel --save
|
58 | ```
|
59 |
|
60 |
|
61 |
|
62 |
|
63 |
|
64 |
|
65 | <a name="section-doc-guides-02-usage-md"></a>
|
66 |
|
67 | Usage
|
68 | ----
|
69 |
|
70 | ```javascript
|
71 | 'use strict'
|
72 |
|
73 | const filedel = require('filedel')
|
74 |
|
75 | // Generate a file.
|
76 | filedel('/src/*.tmp', {
|
77 | force: true
|
78 | }).then(() => {
|
79 | /* ... */
|
80 | })
|
81 |
|
82 | ```
|
83 |
|
84 |
|
85 |
|
86 |
|
87 |
|
88 | <a name="section-doc-guides-03-options-md"></a>
|
89 |
|
90 | Options
|
91 | -----
|
92 |
|
93 | | Name | Default | Description |
|
94 | | --- | --- | --- |
|
95 | | `force` | false | Unlink even if readonly. |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 |
|
101 |
|
102 |
|
103 |
|
104 | <a name="license"></a>
|
105 |
|
106 | License
|
107 | -------
|
108 | This software is released under the [MIT License](https://github.com/okunishinishi/node-filedel/blob/master/LICENSE).
|
109 |
|
110 |
|
111 |
|
112 |
|