@guestlinelabs/react-auth

中文文档
5.0.0发布于 2025/02/07ISCTypeScriptCommonJS零依赖近 30 天下载 7317

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

中文使用文档
文档目录6 节
  1. 如何用取来?
  2. 有效载荷
  3. 捐款
  4. 本地运行
  5. 测试
  6. 如何发布新版本

反应

此库将您提供的接口包成 authentication 剧本. 它允许与反应无缝地融合. 认证 OC 已经贬值, 现在你应该使用 oC 书记官处新的/核证终点。 。 。 .

如何用取来?

  1. 安装库
npm i -S @guestlinelabs/react-auth
  1. 在 AuthProvider
import React from 'react';
import { AuthProvider } from '@guestlinelabs/react-auth';

import App from './App';

export default () => {
  return (
    <AuthProvider>
      <App />
    </AuthProvider>
  );
};
  1. 使用库所曝光的钩子
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>
  );
};

有效载荷

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

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 共发布 40 个版本,首次发布于 2019/12/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
5.0.0latest2025/02/071.8 年前
4.3.22024/09/052 年前
4.3.12024/02/282 年前
4.3.02024/02/222 年前
4.2.02023/07/173 年前
4.1.02023/07/113 年前

关于 @guestlinelabs/react-auth 的常见问题

@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 和提交记录判断。