Members

Functions

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

require('viva-unpack').unpack('1.zip','C:\\unpack_to')

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 = require('viva-unpack').unpack_file('c:\\1.zip','1.txt')

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

require('viva-unpack').pack_local_files('c:\\1.txt','C:\\1.zip')

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

require('viva-unpack').pack_local_files('c:\\1.txt','C:\\1.zip')

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 |