afm-client/bower_components/jszip/documentation/api_zipobject.md

   1 ---
   2 title: "ZipObject API"
   3 layout: default
   4 section: api
   5 ---
   6
   7 This represents an entry in the zip file. If the entry comes from an existing
   8 archive previously [loaded]({{site.baseurl}}/documentation/api_jszip/load.html), the content
   9 will be automatically decompressed/converted first.
  10
  11 ### Attributes
  12
  13 attribute name              | type        | description
  14 ----------------------------|-------------|-------------
  15 `name`                      | string      | the absolute path of the file
  16 `dir`                       | boolean     | true if this is a directory
  17 `date`                      | date        | the last modification date
  18 `comment`                   | string      | the comment for this file
  19 `unixPermissions`           | 16 bits number | The UNIX permissions of the file, if any.
  20 `dosPermissions`            | 6 bits number  | The DOS permissions of the file, if any.
  21 `options`                   | object      | the options of the file. The available options are :
  22 `options.base64`            | boolean     | **Deprecated**, see [file(name, data [,options])]({{site.baseurl}}/documentation/api_jszip/file_data.html)
  23 `options.binary`            | boolean     | **Deprecated**, see [file(name, data [,options])]({{site.baseurl}}/documentation/api_jszip/file_data.html)
  24 `options.dir`               | boolean     | **Deprecated**, use `dir`. True if this is a directory
  25 `options.date`              | date        | **Deprecated**, use `date`. See [file(name, data [,options])]({{site.baseurl}}/documentation/api_jszip/file_data.html)
  26 `options.compression`       | compression | see [file(name, data [,options])]({{site.baseurl}}/documentation/api_jszip/file_data.html)
  27
  28
  29 ### Getters
  30
  31 method            | return type   | description
  32 ------------------|---------------|-------------
  33 `asText()`        | string        | the content as an unicode string.
  34 `asBinary()`      | string        | the content as binary string.
  35 `asArrayBuffer()` | ArrayBuffer   | need a [compatible browser]({{site.baseurl}}/documentation/api_jszip/support.html).
  36 `asUint8Array()`  | Uint8Array    | need a [compatible browser]({{site.baseurl}}/documentation/api_jszip/support.html).
  37 `asNodeBuffer()`  | nodejs Buffer | need [nodejs]({{site.baseurl}}/documentation/api_jszip/support.html).