在前端开发中，我们经常需要操作tar包，如打包、解包等。而在 TypeScript 项目中，使用Node.js的fs模块等时需要进行类型检查，这时就需要用到npm包@types/tar。
安装
使用npm安装@types/tar:
npm install --save-dev @types/tar
用法
导入和解压Tarball
在安装了@types/tar之后，我们可以使用tar包中提供的函数对tar压缩包进行解压、获取其中的文件等操作。首先需要导入：
import * as tar from 'tar';
解压Tarball
对于.tar或.tgz文件，我们可以使用以下代码进行解压：
tar.x({ file: '/path/to/my.tar' });
使用async/await实现异步调用：
async function unzipTarball() { await tar.x({ file: '/path/to/my.tar' }); }
读取tar文件
可以使用以下代码读取文档中指定的tar ball：
const stream = fs.createReadStream('/path/to/my.tar'); const extract = tar.extract(); stream.pipe(extract); extract.on('entry', entry => { console.log(entry.path); });
我们可以看到，代码传入了一个可读流，然后使用fs模块打开tar包，将其从可读流中解压，最后返回一个可写流，该流传递每个文件的入口并打印文件路径到控制台。
TarOptions
在使用时，我们还可以配置TarOptions。以下为常用选项：
cwd
解压/打包时要执行的工作目录。默认是当前工作目录。
tar.c({ cwd: '/myProject' }, ['/dist']);
file
写入/读取的文件路径。
tar.c({ file: '/path/to/my.tar' }, ['/dist']);
gzip
使用gzip进行打包/解包。默认false。
tar.c({ gzip: true }, ['/dist']);
如何使用@types/tar
导入tar包时，可以先导入@types/node。然后导入@types/tar时，tar包的类型就会与Node.js类型一起被自动导入。
import { TarStream } from 'tar';
示例
以下是一个完整的示例代码：
-- -------------------- ---- ------- ------ - -- -- ---- ----- ------ - -- ---- ---- ------- ------ - -- --- ---- ------ ----- ---- - -------------------------------- ----- ----------- - ----------------------------- ----- -------- -------------- - ----- ------- - ------------- ---- --- ------------------- -------- ------- - ----- ---- - ------------------------- ------------ -- ----------- --- ------------ - ------------------ - ---------- ---- --- ------- - ----- --- - ------------------- -- --------------------- - ----------------- - ---------- ---- --- - ----- ------ - --------------------------- --------------------- --- ----- -------- -展开代码
在此示例代码中，我们将解压tarball到指定目的地。我们使用fs.mkdirSync和fs.createWriteStream函数来创建文件结构，并用TarStream的“entry”事件读取输入流中每个文件的元数据。最后，我们将tarball的流部分写入到制定目的地文件中。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110948
