api documentation for yauzl (v2.8.0)

yet another unzip library for node

table of contents

  1. module yauzl
    1. function yauzl.Entry ()
    2. function yauzl.RandomAccessReader ()
    3. function yauzl.ZipFile (reader, centralDirectoryOffset, fileSize, entryCount, comment, autoClose, lazyEntries, decodeStrings, validateEntrySizes )
    4. function yauzl.dosDateTimeToDate (date, time)
    5. function yauzl.fromBuffer (buffer, options, callback)
    6. function yauzl.fromFd (fd, options, callback)
    7. function yauzl.fromRandomAccessReader (reader, totalSize, options, callback)
    8. function yauzl.open (path, options, callback)
    9. function yauzl.validateFileName (fileName)
    10. object yauzl.Entry.prototype
    11. object yauzl.RandomAccessReader.prototype
    12. object yauzl.ZipFile.prototype
  2. module yauzl.Entry
    1. function yauzl.Entry ()
  3. module yauzl.Entry.prototype
    1. function yauzl.Entry.prototype.getLastModDate ()
    2. function yauzl.Entry.prototype.isCompressed ()
    3. function yauzl.Entry.prototype.isEncrypted ()
  4. module yauzl.RandomAccessReader
    1. function yauzl.RandomAccessReader ()
    2. function yauzl.RandomAccessReader.super_ ()
  5. module yauzl.RandomAccessReader.prototype
    1. function yauzl.RandomAccessReader.prototype._readStreamForRange (start, end)
    2. function yauzl.RandomAccessReader.prototype.close (callback)
    3. function yauzl.RandomAccessReader.prototype.createReadStream (options)
    4. function yauzl.RandomAccessReader.prototype.read (buffer, offset, length, position, callback)
    5. function yauzl.RandomAccessReader.prototype.ref ()
    6. function yauzl.RandomAccessReader.prototype.unref ()
  6. module yauzl.ZipFile
    1. function yauzl.ZipFile (reader, centralDirectoryOffset, fileSize, entryCount, comment, autoClose, lazyEntries, decodeStrings, validateEntrySizes )
    2. function yauzl.ZipFile.super_ ()
  7. module yauzl.ZipFile.prototype
    1. function yauzl.ZipFile.prototype.close ()
    2. function yauzl.ZipFile.prototype.openReadStream (entry, options, callback)
    3. function yauzl.ZipFile.prototype.readEntry ()

module yauzl

function yauzl.Entry ()

function yauzl.RandomAccessReader ()

function yauzl.ZipFile (reader, centralDirectoryOffset, fileSize, entryCount, comment, autoClose, lazyEntries, decodeStrings, validateEntrySizes )

function yauzl.dosDateTimeToDate (date, time)

function yauzl.fromBuffer (buffer, options, callback)

function yauzl.fromFd (fd, options, callback)

function yauzl.fromRandomAccessReader (reader, totalSize, options, callback)

function yauzl.open (path, options, callback)

function yauzl.validateFileName (fileName)

module yauzl.Entry

function yauzl.Entry ()

module yauzl.Entry.prototype

function yauzl.Entry.prototype.getLastModDate ()

function yauzl.Entry.prototype.isCompressed ()

function yauzl.Entry.prototype.isEncrypted ()

module yauzl.RandomAccessReader

function yauzl.RandomAccessReader ()

function yauzl.RandomAccessReader.super_ ()

module yauzl.RandomAccessReader.prototype

function yauzl.RandomAccessReader.prototype._readStreamForRange (start, end)

function yauzl.RandomAccessReader.prototype.close (callback)

function yauzl.RandomAccessReader.prototype.createReadStream (options)

function yauzl.RandomAccessReader.prototype.read (buffer, offset, length, position, callback)

function yauzl.RandomAccessReader.prototype.ref ()

function yauzl.RandomAccessReader.prototype.unref ()

module yauzl.ZipFile

function yauzl.ZipFile (reader, centralDirectoryOffset, fileSize, entryCount, comment, autoClose, lazyEntries, decodeStrings, validateEntrySizes )

function yauzl.ZipFile.super_ ()

module yauzl.ZipFile.prototype

function yauzl.ZipFile.prototype.close ()

function yauzl.ZipFile.prototype.openReadStream (entry, options, callback)

function yauzl.ZipFile.prototype.readEntry ()

[ this document was created with utility2 ]