Arta Node.js 图书馆

Arta节点库为在Node.js 18+或任何使用平台运行的应用程序提供与Arta API的无缝集成 无服务器联署材料 使用 Typescript 或 Javascript.

这是一个非常轻的软件包,零运行时依赖性只使用 获取 网易API.

文档

请参考 阿尔塔正式文件。 。 。 .

开始

1. 安装Arta节点库

$ npm install @artaio/node-api

2. 利用它与我们的API在纯粹的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互动

// 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/ 文件夹,包含向国家预防机制发布的内容.