# @artaio/node-api 中文文档

规范地址：https://npmcn.com/package/%40artaio/node-api/

版本：1\.13\.0
npm 元数据更新时间：2026-11-02T15:43:04.973Z
中文译文更新时间：2026-11-06T20:36:19.661Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40artaio/node-api
原文对照：https://npmcn.com/package/%40artaio/node-api/?lang=original
项目主页：https://github.com/artaio/arta-node-api
源码仓库：https://github.com/artaio/arta-node-api

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

- 包体积（解压后）：215 kB，80 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.x
- 运行依赖：0 个
- 首次发布：2022-11-29T15:30:45.160Z
- 最新版本发布：2026-10-16T17:33:55.607Z
- 近 30 天下载量：3662（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：38（近 12 个月 12 个）

## 中文简介

Arta节点库为Arta API提供无缝集成,用于后端应用,同时使用Typescript或Javascript.

## 安装

```sh
npm install @artaio/node-api
```

也可以使用：`pnpm add @artaio/node-api`、`yarn add @artaio/node-api`、`bun add @artaio/node-api`

## README

# Arta Node.js 图书馆

Arta节点库为在Node.js 18+或任何使用平台运行的应用程序提供与Arta API的无缝集成 [无服务器联署材料](https://www.cloudflare.com/learning/serverless/serverless-javascript/) 使用 Typescript 或 Javascript.

这是一个非常轻的软件包,零运行时依赖性只使用 [获取](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) 网易API.

## 文档

请参考 [阿尔塔正式文件](https://api-reference.arta.io/)。 。 。 .

## 开始

### 1\. 安装Arta节点库

```
$ npm install @artaio/node-api
```

### 2\. 利用它与我们的API在纯粹的JS互动

```js
// With top level async/await
const { Arta } = require('@artaio/node-api');
const arta = new Arta('<YOUR_API_TOKEN>');

const { items } = await arta.webhooks.list();
const myHook = items[0];

const pingResult = await myHook.ping();
console.log(pingResult);
```

### 3\. 在TS中利用它与我们的API互动

```ts
// With top level async/await
import { Arta, type Webhook } from '@artaio/node-api';
const arta: Arta = new Arta('<YOUR_API_TOKEN>');

const { items } = await arta.webhooks.list();
const myHook: Webhook = items[0];

const pingResult = await myHook.ping();
console.log(pingResult);
```

## 环境

**警告**:Arta Node SDK原本打算被用在服务器侧javascript上,而取而代之的只是使用WebAPI(fetch)它不应该被用在浏览器上,因为它需要私人API密钥.

这是一个非常小的(约12kb minifed), 0个依赖 JS SDK 用于与Arta 后端交互, 它应该能够在任何支持获取webapi的javascript后端环境中运行.

## 捐款

请了解我们的零依赖政策,并确保在“依赖性”下没有套件 `package.json`。 Dev 依赖关系是好的,因为这些关系将不包含在最后公布的软件包中.

### 发展

要开发 SDK 上的新功能, 运行 `npm install` 以安装所有依赖性(只安装 dev 依赖性),然后运行 `npm run build` 编译的JS代码将存放于 `dist/` 文件夹,包含向国家预防机制发布的内容.

## 常见问题

### @artaio/node-api 是什么？

Arta节点库为Arta API提供无缝集成,用于后端应用,同时使用Typescript或Javascript\.

### 如何安装 @artaio/node-api？

在项目目录运行 npm install @artaio/node-api，或使用 pnpm add / yarn add / bun add。

### @artaio/node-api 支持 TypeScript 吗？

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

### @artaio/node-api 支持 ESM 还是 CommonJS？

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

### @artaio/node-api 需要什么版本的 Node\.js？

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

### @artaio/node-api 可以商用吗？

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

### @artaio/node-api 的下载量有多少？

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

### @artaio/node-api 还在维护吗？

最新版本 1\.13\.0 发布于 2026/10/17（22 天前）；至今共发布 38 个版本，其中过去 12 个月发布了 12 个；首次发布于 2022/11/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。