List or read the files and folders inside archive files.
Supported file extensions:
npm install ls-archive
npm install
grunt
to compile CoffeeScript codegrunt test
to run the specsarchive = require 'ls-archive'
List the files and folders inside the archive file path. The callback
gets
two arguments (error, archiveEntries)
.
archivePath
- The string path to the archive file.
callback
- The function to call after reading completes with an error or
an array of ArchiveEntry objects.
Read the contents of the file path in the archive path and invoke the callback
with those contents. The callback
gets two arguments
(error, filePathContents)
.
archivePath
- The string path to the archive file.
filePath
- The string path inside the archive to read.
callback
- The function to call after reading completes with an error or
the Buffer contents.
Read the contents of the gzipped archive path and invoke the callback with the
Buffer contents of the uncompressed paths. The callback
gets two arguments
(error, pathContents)
.
gzipArchivePath
- The string path to the gzipped archive file.
callback
- The function to call after reading completes with an error or
the Buffer contents.
Class representing a path entry inside an archive file.
Is the entry a file?
Returns true
if a file, false
otherwise.
Is the entry a folder?
Returns true
if a folder, false
otherwise.
Is the entry a symbolic link?
Returns true
if a symbolic link, false
otherwise.
Get the path of this entry.
Returns the string path.
Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.