fflate/docs/classes/zippassthrough.md

Class: ZipPassThrough

A pass-through stream to keep data uncompressed in a ZIP archive.

Hierarchy

• ZipPassThrough

Implements

• ZipInputFile

Index

Constructors

• constructor

Properties

• attrs
• comment
• compression
• crc
• extra
• filename
• mtime
• ondata
• os
• size

Methods

• push

Constructors

constructor

+ new ZipPassThrough(filename: string): ZipPassThrough

Creates a pass-through stream that can be added to ZIP archives

Parameters:

Name	Type	Description
filename	string	The filename to associate with this data stream

Returns: ZipPassThrough

Properties

attrs

• Optional attrs: number

Implementation of ZipInputFile.attrs

---

comment

• Optional comment: string

Implementation of ZipInputFile.comment

---

compression

• compression: number

Implementation of ZipInputFile.compression

---

crc

• crc: number

Implementation of ZipInputFile.crc

---

extra

• Optional extra: Record<number, Uint8Array>

Implementation of ZipInputFile.extra

---

filename

• filename: string

Implementation of ZipInputFile.filename

---

mtime

• Optional mtime: GzipOptions[\"mtime\"]

Implementation of ZipInputFile.mtime

---

ondata

• ondata: AsyncFlateStreamHandler

Implementation of ZipInputFile.ondata

---

os

• Optional os: number

Implementation of ZipInputFile.os

---

size

• size: number

Implementation of ZipInputFile.size

Methods

push

▸ push(chunk: Uint8Array, final?: boolean): void

Pushes a chunk to be added. If you are subclassing this with a custom compression algorithm, note that you must push data from the source file only, pre-compression.

Parameters:

Name	Type	Description
chunk	Uint8Array	The chunk to push
final?	boolean	Whether this is the last chunk

Returns: void