{"id":15297242,"url":"https://github.com/laptou/ia-zip","last_synced_at":"2025-10-07T10:30:58.961Z","repository":{"id":34923009,"uuid":"190680807","full_name":"laptou/ia-zip","owner":"laptou","description":"Better ZIP parsing for Node.js","archived":true,"fork":false,"pushed_at":"2022-02-11T00:42:13.000Z","size":76,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-26T20:15:20.666Z","etag":null,"topics":["node-js","zip"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/laptou.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2019-06-07T03:00:58.000Z","updated_at":"2023-01-27T22:52:15.000Z","dependencies_parsed_at":"2022-08-08T02:16:31.294Z","dependency_job_id":null,"html_url":"https://github.com/laptou/ia-zip","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laptou%2Fia-zip","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laptou%2Fia-zip/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laptou%2Fia-zip/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/laptou%2Fia-zip/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/laptou","download_url":"https://codeload.github.com/laptou/ia-zip/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219877407,"owners_count":16554890,"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":["node-js","zip"],"created_at":"2024-09-30T19:15:55.673Z","updated_at":"2025-10-07T10:30:53.658Z","avatar_url":"https://github.com/laptou.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `ia-zip`\n\n[![npm](https://img.shields.io/npm/v/ia-zip.svg?style=for-the-badge)](https://www.npmjs.com/package/ia-zip)\n![license](https://img.shields.io/npm/l/ia-zip.svg?style=for-the-badge)\n\nThis package provides an API for reading and writing ZIP files.\n\n\u003e **Note**: this package is a work in progress. Right now, you can only read zip files.\n\n# API\nDocs generated using [`docts`](https://github.com/charto/docts)\n\u003e\n\u003e \u003ca name=\"api-ZipCentralDirectoryInfo\"\u003e\u003c/a\u003e\n\u003e ### Interface [`ZipCentralDirectoryInfo`](#api-ZipCentralDirectoryInfo)\n\u003e Source code: [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L135-L145)  \n\u003e  \n\u003e Properties:  \n\u003e \u003e **.currentDiskNumber** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.startDiskNumber** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.entriesOnCurrentDisk** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.totalEntries** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.centralDirectorySize** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.centralDirectoryOffset** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.comment** \u003csup\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.isZip64** \u003csup\u003e\u003ccode\u003eboolean\u003c/code\u003e\u003c/sup\u003e  \n\u003e\n\u003e \u003ca name=\"api-ZipEntryInfo\"\u003e\u003c/a\u003e\n\u003e ### Interface [`ZipEntryInfo`](#api-ZipEntryInfo)\n\u003e Source code: [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L99-L133)  \n\u003e  \n\u003e Properties:  \n\u003e \u003e **.vendor** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.version** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e \u0026emsp;\u003cem\u003eThe ZIP specification version of this file.\u003c/em\u003e  \n\u003e \u003e **.requiredVersion** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e \u0026emsp;\u003cem\u003eThe minimum ZIP specification version required to\u003c/em\u003e  \n\u003e \u003e \u0026emsp;\u003cem\u003eopen this file.\u003c/em\u003e  \n\u003e \u003e **.flags** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.compressionMethod** \u003csup\u003e\u003ccode\u003e(undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined) | (undefined)\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.modificationTime** \u003csup\u003e\u003ccode\u003eDate\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.crc32** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.compressedSize** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.uncompressedSize** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.fileName** \u003csup\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.fileComment** \u003csup\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.attributes** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.localHeaderOffset** \u003csup\u003e\u003ccode\u003enumber\u003c/code\u003e\u003c/sup\u003e  \n\u003e\n\u003e \u003ca name=\"api-ZipReader\"\u003e\u003c/a\u003e\n\u003e ### Class [`ZipReader`](#api-ZipReader)\n\u003e Source code: [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L147-L418)  \n\u003e  \n\u003e Methods:  \n\u003e \u003e **new( )** \u003csup\u003e\u0026rArr; \u003ccode\u003e[ZipReader](#api-ZipReader)\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L172)  \n\u003e \u003e \u0026emsp;\u0026#x25aa; data \u003csup\u003e\u003ccode\u003eBuffer\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **new( )** \u003csup\u003e\u0026rArr; \u003ccode\u003e[ZipReader](#api-ZipReader)\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L173)  \n\u003e \u003e \u0026emsp;\u0026#x25aa; filename \u003csup\u003e\u003ccode\u003estring\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **new( )** \u003csup\u003e\u0026rArr; \u003ccode\u003e[ZipReader](#api-ZipReader)\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L174)  \n\u003e \u003e \u0026emsp;\u0026#x25aa; stream \u003csup\u003e\u003ccode\u003eStream\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.ready( )** \u003csup\u003e\u0026rArr; \u003ccode\u003ePromise\u0026lt;void\u0026gt;\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L180-L183)  \n\u003e \u003e **.readInfo( )** \u003csup\u003e\u0026rArr; \u003ccode\u003ePromise\u0026lt;[ZipCentralDirectoryInfo](#api-ZipCentralDirectoryInfo)\u0026gt;\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L185-L258)  \n\u003e \u003e **.readEntries( )** \u003csup\u003e\u0026rArr; \u003ccode\u003eAsyncIterableIterator\u0026lt;[ZipEntryInfo](#api-ZipEntryInfo)\u0026gt;\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L260-L377)  \n\u003e \u003e **.readEntry( )** \u003csup\u003e\u0026rArr; \u003ccode\u003ePromise\u0026lt;Readable\u0026gt;\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L380-L412)  \n\u003e \u003e \u0026emsp;\u0026#x25aa; entry \u003csup\u003e\u003ccode\u003e[ZipEntryInfo](#api-ZipEntryInfo)\u003c/code\u003e\u003c/sup\u003e  \n\u003e \u003e **.close( )** \u003csup\u003e\u0026rArr; \u003ccode\u003ePromise\u0026lt;void\u0026gt;\u003c/code\u003e\u003c/sup\u003e [`\u003c\u003e`](http://github.com/laptou/ia-zip/blob/fdde2bc/src/parser.ts#L414-L417)  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaptou%2Fia-zip","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flaptou%2Fia-zip","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flaptou%2Fia-zip/lists"}