# @girder/oauth-client 中文文档

规范地址：https://npmcn.com/package/%40girder/oauth-client/

版本：0\.8\.0
npm 元数据更新时间：2025-12-22T20:39:25.696Z
中文译文更新时间：2026-11-16T09:51:47.720Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40girder/oauth-client
原文对照：https://npmcn.com/package/%40girder/oauth-client/?lang=original

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：53.5 kB，26 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2020-12-15T18:19:28.051Z
- 最新版本发布：2022-02-26T01:42:23.295Z
- 近 30 天下载量：2749（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 0 个）

## 中文简介

一个用于执行OAuth登录到Girder 4 (Django)服务器的TypeScript库.

## 安装

```sh
npm install @girder/oauth-client
```

也可以使用：`pnpm add @girder/oauth-client`、`yarn add @girder/oauth-client`、`bun add @girder/oauth-client`

## README

# 用户名

[![npm (scoped)](https://img.shields.io/npm/v/@girder/oauth-client)](https://www.npmjs.com/package/@girder/oauth-client)

一个用于执行OAuth登录到Girder 4 (Django)服务器的TypeScript库.

## 说明

这为Girder 4服务器的认证提供了支持, 使用带有 PKCE 流的 OAuth2.0 授权代码 Grant.

## 使用量

-   安装库 :
    
    ```bash
    yarn add @girder/oauth-client
    ```
    
    或者如果你正在使用 npm:
    
    ```bash
    npm install @girder/oauth-client
    ```
    
-   证明一个 `OauthClient` 包含应用程序的配置 :
    
    ```js
    import OauthClient from '@girder/oauth-client';
    
    const oauthClient = new OauthClient(
      new URL(process.env.OAUTH_API_ROOT), // e.g. 'http://localhost:8000/oauth/'
      process.env.OAUTH_CLIENT_ID, // e.g. 'Qir0Aq7AKIsAkMDLQe9MEfORbHEBKsViNhAKJf1A'
    );
    ```
    
-   打电话 `redirectToLogin` 当开始登录流量时 :
    
    ```js
    document.querySelector('#sign-in-link').addEventListener('click', (event) => {
      event.preventDefault();
      oauthClient.redirectToLogin();
      // This will redirect away from the current page
    });
    ```
    
-   开始时 _每个_ 页面装入, 无条件调用 `maybeRestoreLogin`,试图 恢复登录状态; 如果没有登录, 则不启用 。 之后,获取并存储 HTTP 认证信头 `authHeaders`。 。 。 .
    
    ```js
    let authHeaders;
    oauthClient.maybeRestoreLogin()
      .then(() => {
        authHeaders = oauthClient.authHeaders;
      });
    ```
    

或,如果使用ES6和 `async`编号 :`await`数字 :

```js
await oauthClient.maybeRestoreLogin();
let { authHeaders } = client;
```

-   每个 Ajax API 请求包含这些信头 :
    
    ```js
    fetch('http://localhost:8000/api/files', {
      headers: authHeaders,
    });
    ```
    
-   登录状态将持续到整个页面刷新 。 打电话 `logout` 以清除任何活动登录 :
    
    ```js
    document.querySelector('#sign-out-link').addEventListener('click', (event) => {
      event.preventDefault();
      oauthClient.logout()
        .then(() => {
          authHeaders = oauthClient.authHeaders;
        });
    });
    ```
    

## 示例应用程序

这个寄存器被捆绑在一起 [示例应用程序](https://npmcn.com/package/%40girder/oauth-client/example/index.html)。运行它与 :

```bash
git clone https://github.com/girder/girder-oauth-client.git
yarn install
yarn build
cd example
yarn install
yarn serve
# Visit http://localhost:1234/
```

## 发展

要使用示例应用程序开发库 :

```bash
# From the root of the repository
yarn link
yarn install
yarn watch
```

在另一个终端:

```bash
# From the root of the repository
cd example
yarn link '@girder/oauth-client'
yarn install
yarn serve
```

## 常见问题

### @girder/oauth-client 是什么？

一个用于执行OAuth登录到Girder 4 \(Django\)服务器的TypeScript库\.注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @girder/oauth-client？

在项目目录运行 npm install @girder/oauth-client，或使用 pnpm add / yarn add / bun add。

### @girder/oauth-client 支持 TypeScript 吗？

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

### @girder/oauth-client 支持 ESM 还是 CommonJS？

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

### @girder/oauth-client 可以商用吗？

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

### @girder/oauth-client 的下载量有多少？

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

### @girder/oauth-client 还在维护吗？

最新版本 0\.8\.0 发布于 2022/02/26（4 年前）；至今共发布 14 个版本，其中过去 12 个月发布了 0 个；首次发布于 2020/12/16。作者已将其标记为弃用，新项目建议寻找替代方案。

