summaryrefslogtreecommitdiffstats
path: root/afb-client/bower_components/jszip/documentation/api_jszip/remove.md
blob: af7aa78ce2dc604b7fee76a3f93d9bcf4d8e8eef (plain)
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
---
title: "remove(name)"
layout: default
section: api
---

__Description__ : Delete a file or folder (recursively).

__Arguments__

name | type   | description
-----|--------|------------
name | string | the name of the file/folder to delete.

__Returns__ : The current JSZip object.

__Throws__ : Nothing.

<!--
__Complexity__ : **O(k)** where k is the number of entry to delete (may be > 1
when removing a folder).
-->

__Example__

```js
var zip = new JSZip();
zip.file("Hello.txt", "Hello World\n");
zip.file("temp.txt", "nothing").remove("temp.txt");
// result : Hello.txt

zip.folder("css").file("style.css", "body {background: #FF0000}");
zip.remove("css");
//result : empty zip
```