You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

readme.md 777B

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. # decompress-tarbz2 [![Build Status](https://travis-ci.org/kevva/decompress-tarbz2.svg?branch=master)](https://travis-ci.org/kevva/decompress-tarbz2)
  2. > tar.bz2 decompress plugin
  3. ## Install
  4. ```
  5. $ npm install decompress-tarbz2
  6. ```
  7. ## Usage
  8. ```js
  9. const decompress = require('decompress');
  10. const decompressTarbz = require('decompress-tarbz2');
  11. decompress('unicorn.tar.gz', 'dist', {
  12. plugins: [
  13. decompressTarbz()
  14. ]
  15. }).then(() => {
  16. console.log('Files decompressed');
  17. });
  18. ```
  19. ## API
  20. ### decompressTarbz()(input)
  21. Returns both a `Promise` for a `Buffer` and a [`Duplex stream`](https://nodejs.org/api/stream.html#stream_class_stream_duplex).
  22. #### input
  23. Type: `Buffer` `Stream`
  24. Buffer to decompress.
  25. ## License
  26. MIT © [Kevin Mårtensson](https://github.com/kevva)