# @carecard/jwt-read 中文文档

规范地址：https://npmcn.com/package/%40carecard/jwt-read/

版本：3\.45\.0
npm 元数据更新时间：2026-11-02T19:23:55.863Z
中文译文更新时间：2026-11-09T09:48:57.227Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40carecard/jwt-read
原文对照：https://npmcn.com/package/%40carecard/jwt-read/?lang=original
项目主页：https://github.com/CareCard-ca/pkg-jwt-read#readme
源码仓库：https://github.com/CareCard-ca/pkg-jwt-read

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

- 包体积（解压后）：160 kB，40 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.21\.0 \<25
- 运行依赖：3 个
- 首次发布：2025-12-24T06:03:04.516Z
- 最新版本发布：2026-11-02T19:23:55.517Z
- 近 30 天下载量：3030（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：67（近 12 个月 67 个）

## 中文简介

Jwt 读取函数

## 安装

```sh
npm install @carecard/jwt-read
```

也可以使用：`pnpm add @carecard/jwt-read`、`yarn add @carecard/jwt-read`、`bun add @carecard/jwt-read`

## README

# @carecard/jwt- read (帮助)

通用JWT签名和注册索赔核实. 自定义主张不透明; 角色语义,请求上下文,应用程序所有权,认证-响应化名, 使用寿命属于自己的服务和应用程序.

## 已验证的令牌

`jwtReadVerifiedToken(token, parsedJwks, requirements?)` 返回页眉和有效载荷 只在签署、到期、签发和未确认之后。 无效 证书返回无效。 征召人的要求可以指定发行人,主题,受众 (字符串或列表),最大Ageseconds,并验证索赔。 调用定义 明确采用自定义要求政策;接受有效载荷必须真实返回.

没有应用程序的受众形状或十分钟的寿命默认值。 打电话的人 在核实其合同时,可能需要一个单一的字符串受众 需要一个。 格式错误的要求会提高类型Error.

```js
const { jwtReadVerifiedToken } = require('@carecard/jwt-read');
const parts = jwtReadVerifiedToken(token, verificationJwks, {
  issuer: 'issuer',
  audience: 'receiver',
  maximumAgeSeconds: 900,
  validateClaims: payload => payload.custom === 'expected',
});
```

## 反省和运输

`jwtReadIntrospectedToken(token, introspect, requirements?)` 接受调用规范化 `{ active: true, claims }` 结果和适用同样的明确限制. 它在不推断服务响应领域的情况下保留了犬类习惯主张. 反省失败传播给主人.

`jwtReadBearerToken(header)` 接受一个完整的 HTTP 熊熊证书, 包括外白空间,并拒绝额外的单词或内部符号白空间.

`jwtGetTokenDeadline(payload, maximumAgeSeconds?)` 返回过期或 更早明确的最高年龄,没有商业政策默认。 无效的时间 返回无效. `jwtIsTokenExpired(request, maximumAgeSeconds?)` 检查当前时间 .

现有通用 `jwtGetClientId`, (中文(简体) ), `jwtGetAgeInSeconds`,以及 `jwtIsExpired` 帮助者披露标准对象/计时值. 它们没有赋予任何角色或特权. 特快要求的有效载荷类型只包含已登记和不透明的定制要求.

## 验证

运行 `npm run test:All`, (中文(简体) ), `npm run lint`,以及 `npm run format:check`。测试使用 公共软件包根和操作不透明索赔、可配置身份和 寿命,按键自转,犬形内入,输入错误,以及时间. 企业授权和测绘通过所有者-当地边界进行测试.

不可转让的测试令不规则:每一次测试必须独立通过之前或之后的测试,每一次执行指令的套房都必须通过. 每个测试必须建立它所需要的状态,隔离可变状态,并清理它拥有的状态;它绝不能依赖另一个测试的设置,突变,或清理. 默认测试,CI,和Husky命令必须使用测试框架的普通命令,不得强迫随机命令. 随机顺序执行只是一种明确的诊断,它所暴露出的每一出故障都必须被固定在根源上.

不可谈判的"根源-原因"解决方案规则:总是识别并解决已核实的根源,使用更强的解决方案,并给出正确,持久,生产质量的结果. 绝不将临时工作、资源增加、重试、压制、绕行或只表现的补丁视为补丁。 验证根-原因 固定真实失败的工作流程 并证明结束状态.

不可转让的TDD规则:总是先写出失败的测试,运行以确认它因预期原因失败,然后执行代码并重跑测试直到通过. 所有编码工作都需要测试驱动开发,不得跳过. 仅用于文档或技能编辑,运行相关的焦点非测试 更改道词前验证; 不添加检查的自动测试 出品人、文件或寄存器结构.

不可转让寄存器隔离规则:每个寄存器必须只使用寄存器内包含的文件,代码,定着物,依赖以及服务来运行其Husky钩和测试. 测试和Husky脚本不得导入,要求,阅读,执行,或以其他方式依赖寄存器根外的兄弟姐妹寄存器或路径. app-e2e-测试是唯一的例外,因为交叉存储端到端测试是其明确的责任.

不可转让错误和警告规则:从不压制,沉默,隐藏,降级,过滤,忽略,跳过,或绕过代码,测试,工具,编译器,linters,或验证错误或警告. 修补根源,再重新运行受影响的检查并需要干净的结果. 预期出错路径测试可能断言出错,但绝不能掩盖出乎意料的失败.

不可转让类型脚本类型规则: 永远不要使用类型脚本类型 `any`; 总是使用特定域类型、通用项目类型、现有项目类型,或 `unknown` 在所有类型Script- family文件中明确缩小(`.ts`, (中文(简体) ), `.tsx`, (中文(简体) ), `.mts`, (中文(简体) ), `.cts`,以及 `.d.ts`) (中文(简体) ).

非可转让代码组织规则:具有相同或等同行为的函数必须在整个CareCard寄存器中使用相同或明显对应的描述性名称,等同的功能必须活在每个寄存器既定架构中同名的文件中. 不允许向后兼容名称,别名,或重复位置.

## 常见问题

### @carecard/jwt-read 是什么？

Jwt 读取函数

### 如何安装 @carecard/jwt-read？

在项目目录运行 npm install @carecard/jwt-read，或使用 pnpm add / yarn add / bun add。

### @carecard/jwt-read 支持 TypeScript 吗？

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

### @carecard/jwt-read 支持 ESM 还是 CommonJS？

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

### @carecard/jwt-read 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24\.21\.0 \<25。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @carecard/jwt-read 可以商用吗？

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

### @carecard/jwt-read 的下载量有多少？

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

### @carecard/jwt-read 还在维护吗？

最新版本 3\.45\.0 发布于 2026/11/03（6 天前）；至今共发布 67 个版本，其中过去 12 个月发布了 67 个；首次发布于 2025/12/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。