https://github.com/alexfigliolia/un-gzip
A typescript solution for decompressing gzip files in node
https://github.com/alexfigliolia/un-gzip
Last synced: 3 months ago
JSON representation
A typescript solution for decompressing gzip files in node
- Host: GitHub
- URL: https://github.com/alexfigliolia/un-gzip
- Owner: alexfigliolia
- License: mit
- Created: 2022-11-17T17:49:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-17T22:06:31.000Z (over 2 years ago)
- Last Synced: 2025-02-07T06:11:44.490Z (4 months ago)
- Language: TypeScript
- Size: 43.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# un-gzip
Extract a source .gz archive to a specified destination file.
```
npm install un-gzip
```
## Usage
Pass a source `.gz` file and a destination file and the `.gz` will be extracted to the target file.
``` js
import { unzip } from 'un-gzip'
unzip('example.json.gz', 'example.json');
```
Additionally, you can pass a callback that will be executed when the extraction has completed.
``` js
unzip('example.json.gz', 'example.json', function() {
console.log('This is called when the extraction is completed.');
});
```
## License
MIT