使用NestJS导入ipfs-cluster-api模块时遇类型声明及npm 404错误

问题重现 #

在NestJS中执行import cluster from 'ipfs-cluster-api';时，TypeScript抛出错误：

无法找到模块'ipfs-cluster-api'的声明文件，'/home/user/Documents/nest-code/node_modules/ipfs-cluster-api/src/index.js'隐式拥有'any'类型。

尝试安装官方提示的@types/ipfs-cluster-api时，返回npm 404错误，原因是该类型包未发布到npm registry。

解决方案 #

方法一：创建基础类型声明文件 #

1. 在项目根目录下新建typings文件夹（若不存在）
2. 在该文件夹内创建ipfs-cluster-api.d.ts文件，写入以下代码：

declare module 'ipfs-cluster-api';

3. 修改tsconfig.json的include配置，确保TypeScript能识别这个声明文件：

{
  "include": ["src/**/*", "typings/**/*"]
}

这样就能消除类型错误，模块会被识别为any类型，不影响代码运行。

方法二：自定义详细类型声明（可选） #

如果需要更严格的类型检查，可以根据ipfs-cluster-api的实际API补充类型定义，示例如下：

declare module 'ipfs-cluster-api' {
  interface ClusterOptions {
    host?: string;
    port?: number;
    protocol?: 'http' | 'https';
    username?: string;
    password?: string;
  }

  interface ClusterClient {
    add(data: Buffer | string | ReadableStream): Promise<any>;
    pin(cid: string): Promise<any>;
    unpin(cid: string): Promise<any>;
    // 根据你使用的API方法补充更多类型
  }

  export default function cluster(options?: ClusterOptions): ClusterClient;
}

补充后，TypeScript会提供对应的类型提示，提升开发体验。

内容的提问来源于stack exchange，提问作者Arihant Sameer