Zip

plugins/zip~ Zip

new Zip(optionsopt)

Parameters:
Name Type Attributes Description
options ZipOptions <optional>
Properties
Name Type Attributes Default Description
comment String <optional>

Sets the zip archive comment.

forceLocalTime Boolean <optional>
false

Forces the archive to contain local file times instead of UTC.

forceZip64 Boolean <optional>
false

Forces the archive to contain ZIP64 headers.

store Boolean <optional>
false

Sets the compression method to STORE.

zlib Object <optional>

Passed to zlib

Source:

Methods

append(source, data, callback)

Parameters:
Name Type Description
source Buffer | Stream
data ZipEntryData
Properties
Name Type Attributes Default Description
name String

Sets the entry name including internal path.

date String | Date <optional>
NOW()

Sets the entry date.

mode Number <optional>
D:0755/F:0644

Sets the entry permissions.

prefix String <optional>

Sets a path prefix for the entry name. Useful when working with methods like directory or glob.

stats fs.Stats <optional>

Sets the fs stat data for this entry allowing for reduction of fs stat calls when stat data is already known.

store Boolean <optional>
ZipOptions.store

Sets the compression method to STORE.

callback function
Source:
Returns:

void

finalize()

Source:
Returns:

void

on()

Source:
Returns:

this.engine

pipe()

Source:
Returns:

this.engine

unpipe()

Source:
Returns:

this.engine