Authress SDK for Javascript/Typescript
This is the Authress SDK used to integrate with the authorization as a service provider Authress at https://authress.io .
Usage
npm install @authress/sdk
Then required the package:
import { AuthressClient } from '@authress/sdk';
Getting Started
Reference Guide
See the SDK reference guide for a examples of commonly executed blocks with descriptions.
SDK Documentation
Method Documentation
Frequently Asked Questions
Where do I get a user ID from?
Every JWT contains a user ID, and you can pull it out from there using the TokenVerifier import or verifyToken method. For more details see Authress JWT access tokens .
Framework Examples
See all the available Authress Starter Kits
Contributions
Developing for the Javascript SDK
关于 @authress/sdk 的常见问题@authress/sdk 是什么? Client SDK for Authress authorization as a service. Provides managed authorization api to secure service resources including user data.
如何安装 @authress/sdk? 在项目目录运行 npm install @authress/sdk,或使用 pnpm add / yarn add / bun add。
@authress/sdk 支持 TypeScript 吗? 支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@authress/sdk 支持 ESM 还是 CommonJS? 以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。
@authress/sdk 需要什么版本的 Node.js? package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@authress/sdk 可以商用吗? @authress/sdk 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。
@authress/sdk 的下载量有多少? 根据 npm 官方下载统计,@authress/sdk 在 2026/10/07 – 2026/11/05 这 30 天内被下载 6,672 次,日均约 222 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@authress/sdk 还在维护吗? 最新版本 3.2.289 发布于 2026/09/27(1 个月前);至今共发布 89 个版本,其中过去 12 个月发布了 41 个;首次发布于 2024/01/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。