Members
Functions
- unpack(path_file, path_root, [options]) ⇒
Array.<string> - unpack_text(path_file, name_text_file) ⇒
string - pack_local_files(paths_file_to_pack, path_pack)
- pack_texts(paths_file_to_pack, path_pack)
Typedefs
viva-unpack: (license MIT) recursive zip-archive unpacking made on the library adm-zip
Kind: global variable
Author: Vitalii Vasilev
License: MIT
unpack(path_file, path_root, [options]) ⇒ Array.<string>
Kind: global function
Returns: Array.<string> - all unpacked files
| Param | Type | Description |
|---|---|---|
| path_file | string |
full file name |
| path_root | string |
full root path name |
| [options] | type_options |
Example
unpack_text(path_file, name_text_file) ⇒ string
Kind: global function
| Param | Type | Description |
|---|---|---|
| path_file | string |
full file name |
| name_text_file | string |
file name in archive |
Example
let text = pack_local_files(paths_file_to_pack, path_pack)
Kind: global function
| Param | Type | Description |
|---|---|---|
| paths_file_to_pack | Array.<string> | string |
full file name |
| path_pack | string |
full root path name |
Example
pack_local_files~files : Array.<string>
Kind: inner property of pack_local_files
pack_texts(paths_file_to_pack, path_pack)
Kind: global function
| Param | Type | Description |
|---|---|---|
| paths_file_to_pack | Array.<type_text> | type_text |
full file name |
| path_pack | string |
full root path name |
Example
pack_texts~files : Array.<type_text>
Kind: inner property of pack_texts
type_options
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| extensions | Array.<string> |
list file extension, example - ['docx','epub'] |
| action_extension | string |
ignore extensions ('deny') or allow only this extension ('allow') |
type_text
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| text | string |
body file |
| name | string |
name file |