# @companieshouse/api-sdk-node 中文文档

规范地址：https://npmcn.com/package/%40companieshouse/api-sdk-node/

版本：2\.0\.375
npm 元数据更新时间：2026-11-10T08:00:01.645Z
中文译文更新时间：2026-11-10T13:17:50.085Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40companieshouse/api-sdk-node
原文对照：https://npmcn.com/package/%40companieshouse/api-sdk-node/?lang=original

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

- 包体积（解压后）：661 kB，378 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：5 个
- 首次发布：2020-10-13T09:58:23.727Z
- 最新版本发布：2026-11-10T08:00:00.850Z
- 近 30 天下载量：10123（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：481（近 12 个月 61 个）

## 中文简介

这个SDK抽象的给公共API的电话.

## 安装

```sh
npm install @companieshouse/api-sdk-node
```

也可以使用：`pnpm add @companieshouse/api-sdk-node`、`yarn add @companieshouse/api-sdk-node`、`bun add @companieshouse/api-sdk-node`

## README

# 公司之家 SDK(节点)

这个SDK抽象的给公共API的电话.

用于提供跨网络服务电话、支持电子信息预报系统、向其他服务传播认证细节.

## 兼容的节点版本

这个软件包已经升级,与Node v24兼容. 目前,它与v20和v18是相容的后向兼容,但相容性主要是v24的要求,因为所有的CH节点服务都在被升级到v24的过程中.

## 快开始

利用国家预防机制在你的项目中安装SDK;

```
npm i @companieshouse/api-sdk-node
```

注意此安装可能需要使用"sudo"命令来运行,以避免与文件权限(和Sophos病毒扫描)相关的错误.

以下片段显示如何使用 TypeScript 快速起起跑.

```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类的概念.

```typescript

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 中的服务进行验证 。 遵循关于 [校验库更改关联页面](https://companieshouse.atlassian.net/wiki/spaces/DEV/pages/6404931599/Validating+Library+Upgrades+with+Docker+Before+Merging)如果有问题,请联系共同组成部分小组.

> ⚠️ **注 (仅供参考)**
> 
> 以下说明仅供参考. 它们涉及在本地项目中测试对SDK的修改.
> 
> 他们可能不再像预期的那样工作,而且正在 **未积极维护或支持**。 。 。 .

#### `npm link`

从此目录中运行以下命令,以便在全局节点模块目录中创建一个符号链接:

```
npm link
```

然后从您的本地项目中, 将它与以下命令连接

```
npm link api-sdk-node
```

## 测试

[欢乐](https://jestjs.io/) 是此工程所使用的框架,所有测试都可以使用 npm 运行.

```
npm t
```

以覆盖方式进行测试,通过 `--coverage` 命令行上的旗帜.

```
npm t -- --coverage
```

### 依赖性重叠

-   **[js-yaml@4.1.0 (法语)](mailto:js-yaml@4.1.0)**
    -   原因: [js-yaml@ 3.15.2 (中文(简体) )](mailto:js-yaml@3.15.2) 引入了对 [冲刺-js@1.0.3](mailto:sprintf-js@1.0.3) 结束 [参数@1.0.10](mailto:argparse@1.0.10)中。将更改为 [js-yaml@4.1.0 (法语)](mailto:js-yaml@4.1.0) 升级依赖链以使用 [参数2.0.1](mailto:argparse@2.0.1),去除对弱势版本短跑f-js的依赖. @istanbuljs/load-nyc-config 被设定为覆盖目标,因为这是唯一使用此功能的依赖性 [js-yaml@ 3.15.2 (中文(简体) )](mailto:js-yaml@3.15.2) 版本.
    -   入场券/CVE:cve-2026-97058
    -   后删除 : 一旦更新上游依赖关系以本地消费 js- yaml QQ4. 1.0 后删除此覆盖 。 确保清除后完成适当的测试.

## 常见问题

### @companieshouse/api-sdk-node 是什么？

这个SDK抽象的给公共API的电话\.

### 如何安装 @companieshouse/api-sdk-node？

在项目目录运行 npm install @companieshouse/api-sdk-node，或使用 pnpm add / yarn add / bun add。

### @companieshouse/api-sdk-node 支持 TypeScript 吗？

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

### @companieshouse/api-sdk-node 支持 ESM 还是 CommonJS？

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

### @companieshouse/api-sdk-node 需要什么版本的 Node\.js？

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

### @companieshouse/api-sdk-node 可以商用吗？

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

### @companieshouse/api-sdk-node 的下载量有多少？

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

### @companieshouse/api-sdk-node 还在维护吗？

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