fflate/docs/classes/zip.md

Class: Zip

A zippable archive to which files can incrementally be added

Hierarchy

• Zip

Index

Constructors

• constructor

Properties

• ondata

Methods

• add
• end
• terminate

Constructors

constructor

+ new Zip(cb?: AsyncFlateStreamHandler): Zip

Creates an empty ZIP archive to which files can be added

Parameters:

Name	Type	Description
cb?	AsyncFlateStreamHandler	The callback to call whenever data for the generated ZIP archive is available

Returns: Zip

Properties

ondata

• ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

Methods

add

▸ add(file: ZipInputFile): void

Adds a file to the ZIP archive

Parameters:

Name	Type	Description
file	ZipInputFile	The file stream to add

Returns: void

---

end

▸ end(): void

Ends the process of adding files and prepares to emit the final chunks. This must be called after adding all desired files for the resulting ZIP file to work properly.

Returns: void

---

terminate

▸ terminate(): void

A method to terminate any internal workers used by the stream. Subsequent calls to add() will silently fail.

Returns: void