Constructor
new $k.Zip(archiveNameOrEntityopt)
Creates a new ZIP Archive
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
archiveNameOrEntity | string | | <optional> | The name of archive, a NetEntity or a blob. If a NetEntity or a Blob are provided, then the file entries will be read from that source. |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.0.1
Extends
Methods
addEntry(entity, filenameopt)
Add entity to archive
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
entity | $k. | The new entry | |
filename | string | <optional> | The filename within the archive |
- Inherited From
Throws:
If the archive is already closed
addFolder(foldername) → {$k.ZipDirectory}
Add folder to archive
Parameters:
| Name | Type | Description |
|---|---|---|
foldername | string | Name of the subfolder |
- Inherited From
Returns:
The new folder
- Type:
- $k.
ZipDirectory
build(archiveName) → {$k.NetEntity}
close the archive and return a zip entity
Parameters:
| Name | Type | Description |
|---|---|---|
archiveName | string | The filename of the NetEntity |
Returns:
The zip-file as NetEntity
- Type:
- $k.
NetEntity
directories() → {Array.<$k.ZipDirectory>}
Returns the directories
- Version
- Experimental feature, might be removed at any time
- Inherited From
Returns:
- Type:
- Array.<$k.ZipDirectory>
entry(filename) → {$k.NetEntity}
Returns the entry at the given filename
Parameters:
| Name | Type | Description |
|---|---|---|
filename | string | Filename of the entry |
- Version
- Experimental feature, might be removed at any time
- Overrides
Returns:
The entry
- Type:
- $k.
NetEntity
filename() → {string}
Returns the filename
- Version
- Experimental feature, might be removed at any time
- Inherited From
Returns:
- Type:
- string
filenames() → {Array.<string>}
Returns the entry filenames
- Version
- Experimental feature, might be removed at any time
- Overrides
Returns:
- Type:
- Array.<string>