Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UnzipFile

Streaming file extraction from ZIP archives

Hierarchy

  • UnzipFile

Index

Properties

compression

compression: number

The compression format for the data stream. This number is determined by the spec in PKZIP's APPNOTE.txt, section 4.4.5. For example, 0 = no compression, 8 = deflate, 14 = LZMA. If start() is called but there is no decompression stream available for this method, start() will throw.

name

name: string

The name of the file

ondata

The handler to call whenever data is available

Optional originalSize

originalSize?: number

The original size of the file

Optional size

size?: number

The compressed size of the file

terminate

terminate: AsyncTerminable

A method to terminate any internal workers used by the stream. ondata will not be called any further.

Methods

start

  • start(): void

Generated using TypeDoc