ia-zip

This package provides an API for reading and writing ZIP files.

Note: this package is a work in progress. Right now, you can only read zip files.

API

Docs generated using docts

Interface ZipCentralDirectoryInfo

Source code: <>

Properties:

.currentDiskNumber ^number
.startDiskNumber ^number
.entriesOnCurrentDisk ^number
.totalEntries ^number
.centralDirectorySize ^number
.centralDirectoryOffset ^number
.comment ^string
.isZip64 ^boolean

Interface ZipEntryInfo

Source code: <>

Properties:

.vendor ^number
.version ^number
 The ZIP specification version of this file.
.requiredVersion ^number
 The minimum ZIP specification version required to
 open this file.
.flags ^number
.compressionMethod ^{(undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined)}
.modificationTime ^Date
.crc32 ^number
.compressedSize ^number
.uncompressedSize ^number
.fileName ^string
.fileComment ^string
.attributes ^number
.localHeaderOffset ^number

Class ZipReader

Source code: <>

Methods:

new( ) ^{⇒ ZipReader} <>
 ▪ data ^Buffer
new( ) ^{⇒ ZipReader} <>
 ▪ filename ^string
new( ) ^{⇒ ZipReader} <>
 ▪ stream ^Stream
.ready( ) ^{⇒ Promise<void>} <>
.readInfo( ) ^{⇒ Promise<ZipCentralDirectoryInfo>} <>
.readEntries( ) ^{⇒ AsyncIterableIterator<ZipEntryInfo>} <>
.readEntry( ) ^{⇒ Promise<Readable>} <>
 ▪ entry ^ZipEntryInfo
.close( ) ^{⇒ Promise<void>} <>