@govuk-pay/pay-js-commons

中文文档
7.0.111发布于 2026/11/13MITCommonJS构建来源已验证近 30 天下载 6027

GOV.UK Pay Node.js项目可重复使用的js脚本

中文使用文档
文档目录9 节
  1. 浏览到的脚本
  2. 实地验证
  3. 公用事业
  4. Nunjucks 过滤器
  5. Axios 基础客户端
  6. 安装在重试功能中
  7. 释放
  8. 许可证
  9. 脆弱性的披露

GOV.UK支付联署机构

GOV.UK Pay Node.js项目可重复使用的js脚本

浏览到的脚本

这是我们整个GOV使用的客户端侧脚本的集合. 联合王国 在浏览器中支付。 我们称之为 browsered 因为他们是被写在 节点.js和 已浏览 让他们安全地保护我们 浏览器. 我们浏览器 编辑到微服务中。 。 。 .

脚本列表

实地验证

这是一组可用于输入的验证符 将使用 GOV.UK 元素造型。 。 。 .

校验器 :

需求

这需要来自给定输入的值 :

<form data-validate>
  <div class="govuk-form-group">
    <label for="name">Your name</label>
    <input name="name" data-validate="required" value="" />
  </div>
</form>

货币

这就要求价值是有效的货币金额,即“10”或“9.99”.

<form data-validate>
  <div class="govuk-form-group">
    <label for="amount">Amount</label>
    <input name="amount" data-validate="required currency" value="" />
  </div>
</form>

电子邮件

这需要该值是一个有效的电子邮件地址,其中有一个 电话 结尾(如: 技术 电子邮件不需要.

<form data-validate>
  <div class="govuk-form-group">
    <label for="email">Your email address</label>
    <input name="email" data-validate="email" value="" />
  </div>
</form>

电话

这需要一个11位数的电话号码 和间隔,所以 077 777 777 77 财务报告和审定财务报表 07777777777 两者都有效.

<form data-validate>
  <div class="govuk-form-group">
    <label for="phone">Phone number</label>
    <input name="phone" data-validate="phone" value="" />
  </div>
</form>

HTTPS (韩语)

这需要从https://开始链接

<form data-validate>
  <div class="govuk-form-group">
    <label for="url">Return URL</label>
    <input name="url" data-validate="https" value="" />
  </div>
</form>

数字小于最大值

这要求价值小于十万英镑,因为这被认为是合理的

<form data-validate>
  <div class="govuk-form-group">
    <label for="price">Amount</label>
    <input name="price" data-validate="belowMaxAmount" value="" />
  </div>
</form>

密码

这需要至少10个字符的密码

<form data-validate>
  <div class="govuk-form-group">
    <label for="password">Password</label>
    <input name="password" data-validate="passwordLessThanTenChars" value="" />
  </div>
</form>

最大字符限制

这需要一个数值小于一定数量的字符. 此限制 设置在 data-attribute

<form data-validate>
  <div class="govuk-form-group">
    <label for="title">Title</label>
    <input name="title" data-validate="isFieldGreaterThanMaxLengthChars" data-validate-max-length="255" value="" />
  </div>
</form>

纳西岛

检查一个字段是否包含字符 而不是让NAXSI生气, 意思是像代码注入的字符 即说. < > ; : ` ( ) " \' = | , ~ [ ]

<form data-validate>
  <div class="govuk-form-group">
    <label for="title">Title</label>
    <input name="title" data-validate="isNaxsiSafe" value="" />
  </div>
</form>

公用事业

Nunjucks 过滤器

这些是小型的功能,为尼古丁过滤器提供动力,但也可用于服务器侧面的东西.

这些被加载到 Nunjucks 环境,然后可以在模板中应用变量变化.

例如,如果一个国家作为ISO 代码进入 EN 它可以转换成这样的名字

  <p>{{ countryCode | countryISOtoName }}</p>

或便士值可转换为英镑

  <dl>
    <dt>Amount:</dt>
    <dd>{{ amount | penceToPounds }}</dd>
  </dl>

Axios 基础客户端

在我们的Node.js应用中,用来称呼API,如连接器或分类账.

利用国家预防机制 阿克索斯语Name 图书馆.

基础客户端提供以下配置选项:

  • 请求开始 - 在启动 API 请求前召回函数。 主要用于伐木.
  • 在SuccessResponse - 请求成功完成时召回函数.
  • 失败回复 - 在请求失败时召回函数 .
  • 接受所有状态编码 - boolean
    • 默认情况下,所有非2xx的答复都被视为失败请求.
    • 设定为 true 所有状态代码都被视为成功请求。 您的代码需要适当处理响应 。 目前,仅 pay-frontend 要求设置为 true。 。 。 .

安装在重试功能中

如果有的话 GET 请求以错误消息提供响应 ECONNRESET - Axios基础客户端将自动再尝试2次 - 3次.

默认情况下,在每次失败的请求中,它都会调用 onFailureResponse 调用.

若为 acceptAllStatusCodes=true然后它会叫 onSuccessResponse 调用.

释放

在拉出请求被合并后,Concle将自动创建出一个新的放出拉出请求来递增软件包版本.

此拉力请求必须由开发商审查并合并.

GitHub Actions将向国家预防机制发布新版软件包.

重要性:其他拉力请求会被阻止合并,直到释放拉力请求被合并或关闭.

许可证

MIT 许可证

脆弱性的披露

英国政府 报酬是为了保证每个人的安全. 如果你是一名安全研究者 并且发现了这个守则中的安全弱点 我们很感激你以负责任的方式 帮助我们披露它. 请参看我们 脆弱性披露政策 我们 安全性.txt 详细文件.

版本与发布记录

@govuk-pay/pay-js-commons 共发布 281 个版本,首次发布于 2018/06/12;过去 12 个月发布了 81 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.0.111latest2026/11/134 天前
7.0.1102026/11/124 天前
7.0.1092026/11/097 天前
7.0.1082026/11/0710 天前
7.0.1072026/10/3017 天前
7.0.1062026/10/3017 天前

关于 @govuk-pay/pay-js-commons 的常见问题

@govuk-pay/pay-js-commons 是什么?

GOV.UK Pay Node.js项目可重复使用的js脚本

如何安装 @govuk-pay/pay-js-commons?

在项目目录运行 npm install @govuk-pay/pay-js-commons,或使用 pnpm add / yarn add / bun add。

@govuk-pay/pay-js-commons 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/govuk-pay__pay-js-commons 是否存在。

@govuk-pay/pay-js-commons 支持 ESM 还是 CommonJS?

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

@govuk-pay/pay-js-commons 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js ^24.22.1。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@govuk-pay/pay-js-commons 可以商用吗?

@govuk-pay/pay-js-commons 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@govuk-pay/pay-js-commons 的下载量有多少?

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

@govuk-pay/pay-js-commons 还在维护吗?

最新版本 7.0.111 发布于 2026/11/13(4 天前);至今共发布 281 个版本,其中过去 12 个月发布了 81 个;首次发布于 2018/06/12。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。