# @bity/oauth2-auth-code-pkce 中文文档

规范地址：https://npmcn.com/package/%40bity/oauth2-auth-code-pkce/

版本：2\.13\.0
npm 元数据更新时间：2022-05-10T12:40:22.281Z
中文译文更新时间：2026-11-08T04:54:13.833Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：117 kB，8 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2019-10-17T17:11:03.741Z
- 最新版本发布：2021-06-09T19:42:56.623Z
- 近 30 天下载量：22805（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 0 个）

## 中文简介

OAuth 2. 0 客户端仅支持授权代码与 PKCE 支持相通 .

## 安装

```sh
npm install @bity/oauth2-auth-code-pkce
```

也可以使用：`pnpm add @bity/oauth2-auth-code-pkce`、`yarn add @bity/oauth2-auth-code-pkce`、`bun add @bity/oauth2-auth-code-pkce`

## README

# OAuth2 AuthCodePKCE 客户端

支持零依赖 OAuth 2.0 客户端 _仅限_ 授权代码 补助金([RFC 6749 第4.1节](https://tools.ietf.org/html/rfc6749#section-4.1)与PKCE (英语:[RFC 7636 (英语)](https://tools.ietf.org/html/rfc7636)用于客户端保护.

目前是公共存在中唯一的类型/Java脚本执行.

1 文件执行便于审计.

## 安装

`npm install @bity/oauth2-auth-code-pkce`

## 使用量

见源代码 `tests/panel.html`。它的评论很有帮助 资料.

运行 `npm run serve:tests` 导航到 http://localhost:8080/tests/panel.html (中文(简体) )

本页充当各种情景的试验板. 来玩吧

修改示例以使用正确的配置.

## 返回时显示其它查询字符串参数

一些OAuth服务器会将额外的参数还给请求者. 顺序 必须明确要求他们:

```
config.explicitlyExposedTokens = ['open_id'];
```

然后,这将成为财产: `accessContext.explicitlyExposedTokens.open_id`。 。 。 .

## 其他 OAuth 服务器需要的额外参数

您很可能会遇到 OAuth 服务器, 需要一些额外的 参数。 为了传递额外参数,在 配置 :

```
config.extraAuthorizationParameters = { 'some_query_string_param': 'value', ... };
```

如果您的值需要在运行时计算然后通过,则您 可以这样通过:

```
oauth2.fetchAuthorizationCode({ 'another_query_string_param': computedValue });
```

## 支持模块系统

| 模块系统 | 文件 |
| :-- | :-- |
| 浏览器( 窗口) | 指数.umd.js |
| 普通JS( 需要例如节点) | 指数.js |
| 类型脚本 | 指数.ts |

## 发展

### 向国家预防机制公布

抓好国家预防机制 `bity-oauth2-auth-code-pkce-*.tgz` 来自CI和 然后使用 `npm publish $tarball` 向国家预防机制公布.

## 常见问题

### @bity/oauth2-auth-code-pkce 是什么？

OAuth 2\. 0 客户端仅支持授权代码与 PKCE 支持相通 \.

### 如何安装 @bity/oauth2-auth-code-pkce？

在项目目录运行 npm install @bity/oauth2-auth-code-pkce，或使用 pnpm add / yarn add / bun add。

### @bity/oauth2-auth-code-pkce 支持 TypeScript 吗？

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

### @bity/oauth2-auth-code-pkce 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bity/oauth2-auth-code-pkce 可以商用吗？

@bity/oauth2-auth-code-pkce 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @bity/oauth2-auth-code-pkce 的下载量有多少？

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

### @bity/oauth2-auth-code-pkce 还在维护吗？

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