Yauzl 项目使用教程-优快云博客

Yauzl 项目使用教程

yauzlyet another unzip library for node项目地址:https://gitcode.com/gh_mirrors/ya/yauzl

1. 项目的目录结构及介绍

目录结构

yauzl/
├── bin/
├── lib/
│   ├── deflate.js
│   ├── deserializer.js
│   ├── entry.js
│   ├── fd.js
│   ├── file_attribute.js
│   ├── index.js
│   ├── random_access_reader.js
│   ├── read_entry.js
│   ├── zipfile.js
│   └── zip_serializer.js
├── test/
│   ├── test.js
│   └── test-zip64.js
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── yauzl.js

目录介绍

bin/: 包含可执行文件。
lib/: 包含项目的主要代码文件。
- deflate.js: 处理压缩数据。
- deserializer.js: 反序列化数据。
- entry.js: 处理ZIP文件条目。
- fd.js: 文件描述符处理。
- file_attribute.js: 文件属性处理。
- index.js: 入口文件。
- random_access_reader.js: 随机访问读取器。
- read_entry.js: 读取条目。
- zipfile.js: ZIP文件处理。
- zip_serializer.js: ZIP序列化。
test/: 包含测试文件。
- test.js: 主要测试文件。
- test-zip64.js: ZIP64格式的测试文件。
.gitignore: Git忽略文件。
.npmignore: npm忽略文件。
.travis.yml: Travis CI配置文件。
LICENSE: 许可证文件。
package.json: 项目配置文件。
README.md: 项目说明文档。
yauzl.js: 项目入口文件。

2. 项目的启动文件介绍

启动文件

yauzl.js 是项目的启动文件。它导入了 lib/ 目录下的主要模块，并提供了对外的API接口。

代码示例

const yauzl = require('./yauzl');

yauzl.open('example.zip', {lazyEntries: true}, function(err, zipfile) {
  if (err) throw err;
  zipfile.readEntry();
  zipfile.on('entry', function(entry) {
    console.log(entry.fileName);
    zipfile.readEntry();
  });
});

3. 项目的配置文件介绍

配置文件

package.json 是项目的配置文件，包含了项目的基本信息、依赖、脚本等。

配置文件内容

{
  "name": "yauzl",
  "version": "2.10.0",
  "description": "yet another unzip library for node",
  "main": "yauzl.js",
  "directories": {
    "test": "test"
  },
  "scripts": {
    "test": "node test/test.js"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/thejoshwolfe/yauzl.git"
  },
  "keywords": [
    "unzip",
    "zip",
    "stream",
    "archive",
    "file"
  ],
  "author": "Josh Wolfe <thejoshwolfe@gmail.com>",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/thejoshwolfe/yauzl/issues"
  },
  "homepage": "https://github.com/thejoshwolfe/yauzl#readme",
  "dependencies": {
    "fd-slicer": "~1.1.0"
  }
}