# @guestlinelabs/react-auth 中文文档

规范地址：https://npmcn.com/package/%40guestlinelabs/react-auth/

版本：5\.0\.0
npm 元数据更新时间：2025-02-07T09:31:49.899Z
中文译文更新时间：2026-11-17T03:36:35.305Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40guestlinelabs/react-auth
原文对照：https://npmcn.com/package/%40guestlinelabs/react-auth/?lang=original
源码仓库：https://dev.azure.com/guestlinelabs/Guinea/_git/authentication

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

- 包体积（解压后）：30.9 kB，22 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^16\.9\.0 \|\| ^17 \|\| ^18 \|\| ^19
- 首次发布：2019-12-06T15:40:52.606Z
- 最新版本发布：2025-02-07T09:31:49.521Z
- 近 30 天下载量：7317（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：40（近 12 个月 0 个）

## 中文简介

TODO:简短地介绍一下您的项目。 本节解释这一项目的目标或动机.

## 安装

```sh
npm install @guestlinelabs/react-auth
```

也可以使用：`pnpm add @guestlinelabs/react-auth`、`yarn add @guestlinelabs/react-auth`、`bun add @guestlinelabs/react-auth`

## README

# 反应

此库将您提供的接口包成 `authentication` 剧本. 它允许与反应无缝地融合. 认证 OC 已经贬值, 现在你应该使用 [oC 书记官处新的/核证终点](https://dev.azure.com/guestlinelabs/Core%20Services/_git/oc-registry?path=/src/authentication/README.md)。 。 。 .

## 如何用取来?

1.  安装库

```bash
npm i -S @guestlinelabs/react-auth
```

2.  在 `AuthProvider`

```tsx
import React from 'react';
import { AuthProvider } from '@guestlinelabs/react-auth';

import App from './App';

export default () => {
  return (
    <AuthProvider>
      <App />
    </AuthProvider>
  );
};
```

3.  使用库所曝光的钩子

```tsx
import React from 'react';
import { useAuth } from '@guestlinelabs/react-auth';

export default () => {
  const authResult = useAuth();

  if (authResult.isLoading) {
    return <p>Loading...</p>;
  }

  if (!authResult.isAuthenticated) {
    return <p>You are not logged in...</p>;
  }

  return (
    <div>
      <p>accessToken: {authResult.accessToken}</p>
      <p>idToken: {authResult.idToken}</p>
      <p>userInfo: {JSON.stringify(authResult.userInfo)}</p>
    </div>
  );
};
```

## 有效载荷

钩子会返回这个有效载荷:

```ts
type UseAuth = () => {
  isLoading: boolean;
  isAuthenticated: boolean;
  error: Error | null;
  accessToken: string | null;
  idToken: string | null;
  userInfo: UserInfo | null;

  // Those functions are mostly for the use of the Applications. Open components might use those functions in rare case, for example the logout function in the NavBar
  loginWithRedirect: LoginFunction;
  handleRedirectCallback: HandleLoginCallBackFunction;
  logout: LogoutFunction;
};
```

详情请参见库中的类型.

## 捐款

请联系Sugoi团队并发送公关.

## 本地运行

1.  运行 `npm ci` 在反应-自动目录中
2.  运行 `npm run build` 在反应-自动目录中构建它
3.  运行 `npm link` 在反应- 自动目录中使其在您的机器中全球可用
4.  运行 `npm link @guestlinelabs/react-auth` 在您的应用程序目录中使用本地建筑
5.  运行 `npm run build` 一旦您修改了您的应用程序, 请使用您的新代码

## 测试

1.  运行 `npm ci` 在反应-自动目录中
2.  运行 `npm test` 在反应-自动目录中开始测试

## 如何发布新版本

从 `react-auth` 文件夹

1.  `npm login` 使用 npm.js 的用户名,您需要加入到宾馆组织
2.  `npm ci`
3.  `npm publish`

## 常见问题

### @guestlinelabs/react-auth 是什么？

TODO:简短地介绍一下您的项目。 本节解释这一项目的目标或动机\.

### 如何安装 @guestlinelabs/react-auth？

在项目目录运行 npm install @guestlinelabs/react-auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.9\.0 \|\| ^17 \|\| ^18 \|\| ^19）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @guestlinelabs/react-auth 支持 TypeScript 吗？

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

### @guestlinelabs/react-auth 支持 ESM 还是 CommonJS？

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

### @guestlinelabs/react-auth 可以商用吗？

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

### @guestlinelabs/react-auth 的下载量有多少？

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

### @guestlinelabs/react-auth 还在维护吗？

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

