# @cotar/core 中文文档

规范地址：https://npmcn.com/package/%40cotar/core/

版本：6\.0\.1
npm 元数据更新时间：2023-12-11T22:28:17.879Z
中文译文更新时间：2026-11-11T00:47:35.585Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cotar/core
原文对照：https://npmcn.com/package/%40cotar/core/?lang=original
项目主页：https://github.com/linz/cotar#readme
源码仓库：https://github.com/linz/cotar

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：29.9 kB，21 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：^12\.20\.0 \|\| ^14\.13\.1 \|\| \>=16\.0\.0
- 运行依赖：2 个
- 首次发布：2021-04-07T01:57:46.898Z
- 最新版本发布：2023-12-11T22:28:17.664Z
- 近 30 天下载量：2373（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 0 个）

## 中文简介

鉴于a `.tar` 带有 `.index` 使用 HTTP 范围请求只获取包含文件字节的部分 .

## 安装

```sh
npm install @cotar/core
```

也可以使用：`pnpm add @cotar/core`、`yarn add @cotar/core`、`bun add @cotar/core`

## README

# 云优化TRA @cotar/ core

鉴于a `.tar` 带有 `.index` 使用 HTTP 范围请求只获取包含文件字节的部分 .

举个例子 `@cotar/core` 可以从 100GB tar 文件取取一个 1KB 文件,只有 1 HTTP 范围请求,并且只下载 1KB 。 假设焦油指数被装入内存中 .

## 使用量

要取出一块瓦片, 索引必须装入内存, 然后 cotar 对象提供 a `get(fileName)` 接口以访问 tar 内的任何文件

```typescript
import { Cotar } from '@cotar/core';
import { SourceUrl } from '@chunkd/source-url';

const source = new SourceUrl('s3://linz-basemaps/topographic.tar.co');
const cotar = Cotar.fromTar(source);

// Fetch a gzipped PBF file from  a tar
const bytes = await cotar.get(`tiles/z10/5/5.pbf.gz`);
```

### 创建索引

索引可以使用 `@cotar/cli` 软件包或程序 `CotarIndexBuilder`

```typescript
import { CotarIndexBuilder } from '@cotar/builder';
import * as fs from 'fs/promises';

const fd = await fs.open('tarFile.tar', 'r');
const res = await CotarIndexBuilder.create(fd, CotarIndex.Binary);
await fs.write('tarFile.tar.index', res.buffer);
await fd.close();
```

## 常见问题

### @cotar/core 是什么？

鉴于a \.tar 带有 \.index 使用 HTTP 范围请求只获取包含文件字节的部分 \.

### 如何安装 @cotar/core？

在项目目录运行 npm install @cotar/core，或使用 pnpm add / yarn add / bun add。

### @cotar/core 支持 TypeScript 吗？

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

### @cotar/core 支持 ESM 还是 CommonJS？

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

### @cotar/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js ^12\.20\.0 \|\| ^14\.13\.1 \|\| \>=16\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cotar/core 可以商用吗？

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

### @cotar/core 的下载量有多少？

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

### @cotar/core 还在维护吗？

最新版本 6\.0\.1 发布于 2023/12/12（2 年前）；至今共发布 15 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/04/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。