summaryrefslogtreecommitdiffstats
path: root/afb-client/bower_components/jszip/documentation/api_jszip/file_name.md
diff options
context:
space:
mode:
authorStephane Desneux <stephane.desneux@iot.bzh>2016-05-31 18:16:48 +0200
committerStephane Desneux <stephane.desneux@iot.bzh>2016-05-31 18:16:48 +0200
commit5b1e6cc132f44262a873fa8296a2a3e1017b0278 (patch)
tree43b2cd54e2e300b399ff3f2af4458a2c4ed8a144 /afb-client/bower_components/jszip/documentation/api_jszip/file_name.md
parentf7d2f9ac4168ee5064580c666d508667a73cefc0 (diff)
parent85ace9c1ce9a98e9b8a22f045c7dd752b38d9129 (diff)
Merge afb-client
Diffstat (limited to 'afb-client/bower_components/jszip/documentation/api_jszip/file_name.md')
-rw-r--r--afb-client/bower_components/jszip/documentation/api_jszip/file_name.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/afb-client/bower_components/jszip/documentation/api_jszip/file_name.md b/afb-client/bower_components/jszip/documentation/api_jszip/file_name.md
new file mode 100644
index 0000000..88b6d43
--- /dev/null
+++ b/afb-client/bower_components/jszip/documentation/api_jszip/file_name.md
@@ -0,0 +1,46 @@
+---
+title: "file(name)"
+layout: default
+section: api
+---
+
+__Description__ : Get a file with the specified name. You can specify folders
+in the name : the folder separator is a forward slash ("/").
+
+__Arguments__
+
+name | type | description
+-----|--------|-------------
+name | string | the name of the file.
+
+__Returns__ : An instance of [ZipObject]({{site.baseurl}}/documentation/api_zipobject.html) representing
+the file if any, `null` otherwise.
+
+__Throws__ : Nothing.
+
+<!-- __Complexity__ : This is a simple lookup in **O(1)**. -->
+
+__Examples__
+
+```js
+var zip = new JSZip();
+zip.file("file.txt", "content");
+
+zip.file("file.txt").name // "file.txt"
+zip.file("file.txt").asText() // "content"
+zip.file("file.txt").options.dir // false
+
+// utf8 example
+var zip = new JSZip(zipFromAjaxWithUTF8);
+zip.file("amount.txt").asText() // "€15"
+zip.file("amount.txt").asArrayBuffer() // an ArrayBuffer containing €15 encoded as utf8
+zip.file("amount.txt").asUint8Array() // an Uint8Array containing €15 encoded as utf8
+
+// with folders
+zip.folder("sub").file("file.txt", "content");
+zip.file("sub/file.txt"); // the file
+// or
+zip.folder("sub").file("file.txt") // the file
+```
+
+