@axiomhq/js

中文文档
2.0.0发布于 2026/08/04MITTypeScriptESM + CJS构建来源已验证近 30 天下载 330.7万

The official javascript bindings for the Axiom API

原始使用文档
文档目录4 节
  1. Requirements
  2. Install
  3. Documentation
  4. License

Axiom JavaScript SDK

The Axiom JavaScript SDK allows you to send data from a JavaScript app to Axiom.

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();

Custom products are appended to the X-Axiom-Client header, for example axiom-js/<version> my-app/1.0. You can also append products after creating the client with axiom.appendAxiomClient('my-integration/1.0').

Requirements

Node.js 20 or higher is required. Node.js 18 is no longer supported.

Install

npm install @axiomhq/js

Documentation

For more information about how to set up and use the Axiom JavaScript SDK, read documentation on axiom.co/docs/guides/javascript.

License

MIT

版本与发布记录

@axiomhq/js 共发布 21 个版本,首次发布于 2023/06/14;过去 12 个月发布了 7 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
2.0.0latest2026/08/043 个月前
1.8.02026/06/294 个月前
1.7.02026/06/184 个月前
1.6.12026/05/076 个月前
1.6.02026/03/317 个月前
1.5.02026/03/217 个月前

关于 @axiomhq/js 的常见问题

@axiomhq/js 是什么?

The official javascript bindings for the 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 和提交记录判断。