# @axiomhq/js 中文文档

规范地址：https://npmcn.com/package/%40axiomhq/js/

版本：2\.0\.0
npm 元数据更新时间：2026-09-03T13:20:58.859Z
中文译文更新时间：2026-11-07T10:52:51.434Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40axiomhq/js
原文对照：https://npmcn.com/package/%40axiomhq/js/?lang=original
项目主页：https://github.com/axiomhq/axiom-js/blob/main/packages/js/README.md
源码仓库：https://github.com/axiomhq/axiom-js

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

- 包体积（解压后）：559 kB，123 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：1 个
- 首次发布：2023-06-14T13:22:09.902Z
- 最新版本发布：2026-08-04T10:18:14.663Z
- 近 30 天下载量：3307217（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 7 个）

## 中文简介

官方 Javascript 绑定 Axiom API

## 安装

```sh
npm install @axiomhq/js
```

也可以使用：`pnpm add @axiomhq/js`、`yarn add @axiomhq/js`、`bun add @axiomhq/js`

## README

# 轴 Java 脚本 SDK

Axiom JavaScript SDK允许您将JavaScript应用程序的数据发送到Axiom.

```ts
import { Axiom } from '@axiomhq/js';

const axiom = new Axiom({
  token: process.env.AXIOM_TOKEN,
  axiomClient: 'my-app/1.0',
});

axiom.ingest('DATASET_NAME', [{ foo: 'bar' }]);
await axiom.flush();
```

自定义产品附于 `X-Axiom-Client` 例如,页眉 `axiom-js/<version> my-app/1.0`。 。 。 . 您也可以在创建客户端后附加产品 `axiom.appendAxiomClient('my-integration/1.0')`。 。 。 .

## 所需资源

需要20个或以上的节点。 节点.js 18不再支持.

## 安装

```bash
npm install @axiomhq/js
```

## 文档

有关如何设置和使用 Axiom JavaScript SDK 的更多信息,请读作文档 [axiom.co/docs/指向/标注](https://axiom.co/docs/guides/javascript)。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/LICENSE)

## 常见问题

### @axiomhq/js 是什么？

官方 Javascript 绑定 Axiom API

### 如何安装 @axiomhq/js？

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

### @axiomhq/js 支持 TypeScript 吗？

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

### @axiomhq/js 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

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

### @axiomhq/js 可以商用吗？

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

### @axiomhq/js 的下载量有多少？

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

### @axiomhq/js 还在维护吗？

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