lickumap / node-xarchive

Extensible Archive Format

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

xarchive

npm npm license npm downloads build status

Extensible Archive Format

Install via npm

$ npm install --save xarchive

Usage

var xar = require( 'xarchive' )

Opening an Archive

var archive = new xar.Archive( 'something.xar' )

archive.open( function( error ) {
  // ...
})

Reading Directories

archive.readdir( '/', ( error, ls ) => {
  console.log( error || ls )
})
[ 'file.txt', 'subdirectory' ]

Reading Files

Reading an entire file:

archive.readFile( 'file.txt', function( error, buffer ) {
  // ...
})

Streaming from a file:

var readableStream = archive.createReadStream( 'file.txt' )

References

About

Extensible Archive Format

License:MIT License


Languages

Language:JavaScript 100.0%