公司之家 SDK(节点)
这个SDK抽象的给公共API的电话.
用于提供跨网络服务电话、支持电子信息预报系统、向其他服务传播认证细节.
兼容的节点版本
这个软件包已经升级,与Node v24兼容. 目前,它与v20和v18是相容的后向兼容,但相容性主要是v24的要求,因为所有的CH节点服务都在被升级到v24的过程中.
快开始
利用国家预防机制在你的项目中安装SDK;
npm i @companieshouse/api-sdk-node
注意此安装可能需要使用"sudo"命令来运行,以避免与文件权限(和Sophos病毒扫描)相关的错误.
以下片段显示如何使用 TypeScript 快速起起跑.
import {createApiClient} from "@companieshouse/api-sdk-node";
(async () => {
const api = createApiClient("your-api-key");
const profile = await api.companyProfile.getCompanyProfile("00006400");
console.log(profile);
})()
有另一种方式可以调用一些服务,这迫使您检查错误。 它借用了功能编程中发现的Ouh类的概念.
import {createApiClient} from "@companieshouse/api-sdk-node";
(async () => {
const api = createApiClient("your-api-key");
const orderResult = await api.companyProfile.getOrder("an-existing-order-id");
if(orderResult.isFailure()) {
const errorResponse = orderResult.value;
console.log(errorResponse);
} else {
const order = orderResult.value;
console.log(order);
}
})()
发展
一旦您对库进行了修改, 您必须在将您的 PR 合并为主之前对 Docker 中的服务进行验证 。 遵循关于 校验库更改关联页面如果有问题,请联系共同组成部分小组.
⚠️ 注 (仅供参考)
以下说明仅供参考. 它们涉及在本地项目中测试对SDK的修改.
他们可能不再像预期的那样工作,而且正在 未积极维护或支持。 。 。 .
npm link
从此目录中运行以下命令,以便在全局节点模块目录中创建一个符号链接:
npm link
然后从您的本地项目中, 将它与以下命令连接
npm link api-sdk-node
测试
欢乐 是此工程所使用的框架,所有测试都可以使用 npm 运行.
npm t
以覆盖方式进行测试,通过 --coverage 命令行上的旗帜.
npm t -- --coverage
依赖性重叠
- [email protected] (法语)
- 原因: js-yaml@ 3.15.2 (中文(简体) ) 引入了对 冲刺[email protected] 结束 参数@1.0.10中。将更改为 [email protected] (法语) 升级依赖链以使用 参数2.0.1,去除对弱势版本短跑f-js的依赖. @istanbuljs/load-nyc-config 被设定为覆盖目标,因为这是唯一使用此功能的依赖性 js-yaml@ 3.15.2 (中文(简体) ) 版本.
- 入场券/CVE:cve-2026-97058
- 后删除 : 一旦更新上游依赖关系以本地消费 js- yaml QQ4. 1.0 后删除此覆盖 。 确保清除后完成适当的测试.