# @authsignal/node 中文文档

规范地址：https://npmcn.com/package/%40authsignal/node/

版本：3\.2\.3
npm 元数据更新时间：2026-09-30T02:51:07.595Z
中文译文更新时间：2026-11-07T06:12:05.673Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：87.8 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2022-05-25T23:11:44.471Z
- 最新版本发布：2026-09-30T02:51:07.157Z
- 近 30 天下载量：17186（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：101（近 12 个月 18 个）

## 中文简介

![Authsignal](https://raw.githubusercontent.com/authsignal/authsignal-node/main/.github/images/authsignal.png)

## 安装

```sh
npm install @authsignal/node
```

也可以使用：`pnpm add @authsignal/node`、`yarn add @authsignal/node`、`bun add @authsignal/node`

## README

![Authsignal](https://raw.githubusercontent.com/authsignal/authsignal-node/main/.github/images/authsignal.png)

# Authignal 节点.js SDK

[![NPM version](https://img.shields.io/npm/v/@authsignal/node.svg)](https://npmjs.org/package/@authsignal/node) [![License](https://img.shields.io/npm/l/@authsignal/node.svg)](https://github.com/authsignal/authsignal-node/blob/main/LICENSE.md)

Authignal Node.js 服务器侧应用的官方库. 使用此 SDK 来方便地将 Authignal 的多要素认证(MFA)和无密码特性集成到您的Node.js后端.

## 安装

使用 npm :

```bash
npm install @authsignal/node
```

使用线条 :

```bash
yarn add @authsignal/node
```

使用 pnpm :

```bash
pnpm add @authsignal/node
```

使用包子 :

```bash
bun add @authsignal/node
```

## 开始

用您的密钥初始化认证客户端 [认证门户](https://portal.authsignal.com/) 和您的区域的 API URL .

```typescript
import { Authsignal } from "@authsignal/node";

// Initialize the client
const authsignal = new Authsignal({
  apiSecretKey: process.env.AUTHSIGNAL_SECRET_KEY,
  apiUrl: process.env.AUTHSIGNAL_API_URL, // Use region-specific URL
});
```

### 按区域划分的 API URL

| 地区 | API 網址 |
| --- | --- |
| 美国( 奥来贡) | [https://api.authsignal.com/v1 (中文(简体) )](https://api.authsignal.com/v1) |
| 非盟(悉尼) | [https://au.api.authsignal.com/v1 请检查isbn=值 (帮助)](https://au.api.authsignal.com/v1) |
| 欧盟(都柏林) | [https://eu.api.authsignal.com/v1 请检查isbn=值 (帮助)](https://eu.api.authsignal.com/v1) |

## 许可证

这个SDK是依照 [MIT 许可证](https://npmcn.com/package/%40authsignal/node/LICENSE.md)。 。 。 .

## 文档

更多信息和高级使用实例,请参见官员 [认证服务器- Side SDK 文档](https://docs.authsignal.com/sdks/server/overview)。 。 。 .

## 常见问题

### 如何安装 @authsignal/node？

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

### @authsignal/node 支持 TypeScript 吗？

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

### @authsignal/node 支持 ESM 还是 CommonJS？

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

### @authsignal/node 可以商用吗？

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

### @authsignal/node 的下载量有多少？

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

### @authsignal/node 还在维护吗？

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