{"id":29189389,"url":"https://github.com/coderaiser/node-tar-to-zip","last_synced_at":"2025-07-01T23:07:25.201Z","repository":{"id":65412323,"uuid":"72868059","full_name":"coderaiser/node-tar-to-zip","owner":"coderaiser","description":"convert tar and tar.gz archives to zip","archived":false,"fork":false,"pushed_at":"2020-11-10T18:19:30.000Z","size":40,"stargazers_count":11,"open_issues_count":0,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-24T08:23:51.886Z","etag":null,"topics":["convert","emitter","gzip","stream","tar","zip"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderaiser.png","metadata":{"files":{"readme":"README.md","changelog":"ChangeLog","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-04T17:01:22.000Z","updated_at":"2023-07-29T20:57:46.000Z","dependencies_parsed_at":"2023-01-22T07:45:19.511Z","dependency_job_id":null,"html_url":"https://github.com/coderaiser/node-tar-to-zip","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/coderaiser/node-tar-to-zip","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderaiser%2Fnode-tar-to-zip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderaiser%2Fnode-tar-to-zip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderaiser%2Fnode-tar-to-zip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderaiser%2Fnode-tar-to-zip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderaiser","download_url":"https://codeload.github.com/coderaiser/node-tar-to-zip/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderaiser%2Fnode-tar-to-zip/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262090385,"owners_count":23257133,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["convert","emitter","gzip","stream","tar","zip"],"created_at":"2025-07-01T23:07:24.519Z","updated_at":"2025-07-01T23:07:25.135Z","avatar_url":"https://github.com/coderaiser.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tar-to-zip [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]\n\nConvert tar and tar.gz archives to zip.\n\n## Global\n\n`tar-to-zip` could be installed globally and used as `tar-to-zip` or `tar2zip`:\n\n```\nnpm i tar-to-zip -g\n```\n\n### Usage\n\nConvert all `tar.gz` archives to `zip` in same directory:\n\n```\ntar2zip *.tar.gz\n```\n\n\u003e Make every program a filter\n\u003e\n\u003e (c) Mike Gancarz: The UNIX Philosophy\n\nConvert `tar` data from `stdin` and pipe it to `stdout`.\n\n```\ncat arc.tar | tar2zip \u003e arc.zip\n```\n\n## Local\n\n`tar-to-zip` could be used localy. It will emit event on every file from converted archive.\n\n## Install\n\n```\nnpm i tar-to-zip --save\n```\n\n## API\n\n`tar-to-zip` can work with `filename` and `ReadableStream`. When `filename` used `tar-to-zip` can emit\nprogress of coverting (with `options`: `{progress: true}`).\n\n`tar-to-zip` can transform the files as they are being processed using `options`: `map` and `filter`.\n\n### tarToZip(filename, {progress})\n\n- `filename` - **string** name of the file\n- `options` - **object** with properties:\n  - `progress` - whether emit `progress` event.\n\n```js\nconst tarToZip = require('tar-to-zip');\nconst fs = require('fs');\nconst {stdout} = process;\n\nconst onProgress = (n) =\u003e {\n    stdout.write(`\\r${n}`);\n};\n\nconst onFinish = (e) =\u003e {\n    stdout.write('\\n');\n};\n\nconst onError = ({message}) =\u003e {\n    console.error(message);\n};\n\nconst zip = fs.createWriteStream('file.zip');\nconst progress = true;\n\ntarToZip('file.tar.gz', {progress})\n    .on('progress', onProgress)\n    .on('file', console.log)\n    .on('error', onError)\n    .getStream()\n    .pipe(zip)\n    .on('finish', onFinish);\n\n```\n\n### tarToZip(stream)\n\n- `stream` - **ReadableStream** with `tar` data.\n\n```js\nconst tarToZip = require('tar-to-zip');\nconst fs = require('fs');\nconst {stdout} = process;\n\nconst onProgress = (n) =\u003e {\n    stdout.write(`\\r${n}`);\n};\nconst onFinish = (e) =\u003e {\n    stdout.write('\\n');\n};\n\nconst onError = ({message}) =\u003e {\n    console.error(message)\n};\n\nconst tar = fs.createReadStream('file.tar.gz');\nconst zip = fs.createWriteStream('file.zip');\nconst progress = true;\n\ntarToZip(tar, {progress})\n    .on('progress', onProgress)\n    .on('file', console.log)\n    .on('error', onError)\n    .getStream()\n    .pipe(zip)\n    .on('finish', onFinish);\n```\n\n### tarToZip(stream, {filter, map})\n\n- `options` - **ReadableStream** with `tar` data.\n  - `filter` - function to filter out files. Return `false` to exclude a file.\n  - `map` - function to transform file name/type.\n\n```js\nconst tarToZip = require('tar-to-zip');\nconst fs = require('fs');\nconst {stdout} = process;\nconst onProgress = (n) =\u003e {\n    stdout.write(`\\r${n}`);\n};\n\nconst onFinish = (e) =\u003e {\n    stdout.write('\\n');\n};\n\nconst onError = ({message}) =\u003e {\n    console.error(message);\n};\n\nconst zip = fs.createWriteStream('file.zip');\nconst progress = false;\n\n// exclude all but example.txt\nconst filter = ({name}) =\u003e {\n    return name === 'example.txt';\n};\n\n// replace all .txt extensions with .doc\nconst map = ({name}) =\u003e {\n    return {\n        name: name.replace(/\\.txt$/, '.doc')\n    };\n};\n\ntarToZip('file.tar.gz', {filter, map, progress})\n    .on('progress', onProgress)\n    .on('file', console.log)\n    .on('error', onError)\n    .getStream()\n    .pipe(zip)\n    .on('finish', onFinish);\n\n```\n\n## Related\n\n- [Jag](https://github.com/coderaiser/node-jag \"Jag\") - Pack files and folders with tar and gzip.\n- [Jaguar](https://github.com/coderaiser/node-jaguar \"Jaguar\") - Pack and extract .tar.gz archives with emitter.\n- [OneZip](https://github.com/coderaiser/node-onezip \"OneZip\") - Pack and extract zip archives with emitter.\n- [zip-to-tar](https://github.com/coderaiser/node-zip-to-tar \"Zip To Tar\") - Convert zip archives to tar.\n\n## License\n\nMIT\n\n[NPMIMGURL]:                https://img.shields.io/npm/v/tar-to-zip.svg?style=flat\n[BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/node-tar-to-zip/master.svg?style=flat\n[DependencyStatusIMGURL]:   https://img.shields.io/david/coderaiser/node-tar-to-zip.svg?style=flat\n[LicenseIMGURL]:            https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat\n[NPMURL]:                   https://npmjs.org/package/tar-to-zip \"npm\"\n[BuildStatusURL]:           https://travis-ci.org/coderaiser/node-tar-to-zip  \"Build Status\"\n[DependencyStatusURL]:      https://david-dm.org/coderaiser/node-tar-to-zip \"Dependency Status\"\n[LicenseURL]:               https://tldrlegal.com/license/mit-license \"MIT License\"\n\n[CoverageURL]:              https://coveralls.io/github/coderaiser/node-tar-to-zip?branch=master\n[CoverageIMGURL]:           https://coveralls.io/repos/coderaiser/node-tar-to-zip/badge.svg?branch=master\u0026service=github\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderaiser%2Fnode-tar-to-zip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderaiser%2Fnode-tar-to-zip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderaiser%2Fnode-tar-to-zip/lists"}