@gera2ld/tarjs

中文文档
0.3.1发布于 2023/10/21MITTypeScriptES Module近 30 天下载 5.8万

A zero-dependency JavaScript library to read and write tar files.

原始使用文档
文档目录4 节
  1. Features
  2. Limitations
  3. Usage
  4. Credits

@gera2ld/tarjs

A zero-dependency JavaScript library to read and write tar files.

Features

  • reading and writing
  • UTF-8 support for filenames and contents
  • no dependency, with support for Node.js, browsers, Deno

Limitations

  • File name (including path) has to be less than 100 characters
  • Maximum total file size seems to be limited to somewhere between 500MB to 1GB (exact limit is unknown)

Usage

// ESM
import { TarReader, TarWriter } from '@gera2ld/tarjs';
// IIFE
const { TarReader, TarWriter } = window.tarjs;

const reader = await TarReader.load(tarFile);
console.log('Loaded items:', reader.fileInfos);

Check jsdoc for API reference.

Credits

版本与发布记录

@gera2ld/tarjs 共发布 8 个版本,首次发布于 2021/03/09;过去 12 个月发布了 0 个版本。

版本发布日期距今
0.3.1latest2023/10/213 年前
0.3.02023/10/213 年前
0.2.22023/01/073 年前
0.2.12023/01/043 年前
0.2.02023/01/043 年前
0.1.22021/03/095 年前

关于 @gera2ld/tarjs 的常见问题

@gera2ld/tarjs 是什么?

A zero-dependency JavaScript library to read and write tar files.

如何安装 @gera2ld/tarjs?

在项目目录运行 npm install @gera2ld/tarjs,或使用 pnpm add / yarn add / bun add。

@gera2ld/tarjs 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gera2ld/tarjs 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@gera2ld/tarjs 可以商用吗?

@gera2ld/tarjs 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gera2ld/tarjs 的下载量有多少?

根据 npm 官方下载统计,@gera2ld/tarjs 在 2026/10/16 – 2026/11/14 这 30 天内被下载 58,155 次,日均约 1,939 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gera2ld/tarjs 还在维护吗?

最新版本 0.3.1 发布于 2023/10/21(3 年前);至今共发布 8 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/03/09。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。