UNPKG

2.89 kBMarkdownView Raw
1filedel
2==========
3
4<!---
5This file is generated by ape-tmpl. Do not update manually.
6--->
7
8<!-- Badge Start -->
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<!-- Badge End -->
34
35
36<!-- Description Start -->
37<a name="description"></a>
38
39Delete files.
40
41<!-- Description End -->
42
43
44
45
46<!-- Sections Start -->
47<a name="sections"></a>
48
49<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->
50
51<a name="section-doc-guides-01-installation-md"></a>
52
53Installation
54-----
55
56```bash
57npm install filedel --save
58```
59
60
61<!-- Section from "doc/guides/01.Installation.md.hbs" End -->
62
63<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->
64
65<a name="section-doc-guides-02-usage-md"></a>
66
67Usage
68----
69
70```javascript
71'use strict'
72
73const filedel = require('filedel')
74
75// Generate a file.
76filedel('/src/*.tmp', {
77 force: true
78}).then(() => {
79 /* ... */
80})
81
82```
83
84<!-- Section from "doc/guides/02.Usage.md.hbs" End -->
85
86<!-- Section from "doc/guides/03.Options.md.hbs" Start -->
87
88<a name="section-doc-guides-03-options-md"></a>
89
90Options
91-----
92
93| Name | Default | Description |
94| --- | --- | --- |
95| `force` | false | Unlink even if readonly. |
96
97<!-- Section from "doc/guides/03.Options.md.hbs" End -->
98
99
100<!-- Sections Start -->
101
102
103<!-- LICENSE Start -->
104<a name="license"></a>
105
106License
107-------
108This software is released under the [MIT License](https://github.com/okunishinishi/node-filedel/blob/master/LICENSE).
109
110<!-- LICENSE End -->
111
112