TypeScript库声明文件共享问题：子类无法识别父类类型

背景情况 #

自研库中使用了无类型的外部库类A，并创建了继承自A的类B。为给A添加类型支持，创建了lib/typings/external-lib.d.ts声明文件：

/// <reference types="node" />
declare module 'external-lib' {
    export class A {
        param1: string
        param2: string

        sayHi(): void
        constructor(e: any)
    }

    export default TronWeb
}

类B的实现代码：

import A from 'external-lib'

export class B extends A {
    constructor(options: any[]) {
         super(options)
    }

    doStuff(): void {
         console.log('Hi!')
         console.log('Param1:', this.param1) // 库内部编译无问题
    }
}

自研库的tsconfig.json配置：

{
    "compilerOptions": {
        "baseUrl": "./",
        "module": "commonjs",
        "outDir": "./dist",
        "target": "es2017",
        "types": ["node", "jest"],
        "allowSyntheticDefaultImports": true,
        "declaration": true,
        "emitDecoratorMetadata": true,
        "esModuleInterop": true,
        "experimentalDecorators": true,
        "incremental": true,
        "removeComments": true,
        "skipLibCheck": true,
        "sourceMap": true, 
        "typeRoots": ["lib/typings", "node_modules/@types"]
    },
    "exclude": ["node_modules", "dist"],
    "include": ["lib/**/*", "typings/**/*", "test/**/*"]
}

自研库编译成功，但在外部项目中使用时，实例化B后只能访问B自身的方法，无法访问继承自A的属性和方法，TypeScript提示“属性/方法不存在”：

const b = new B({ option1: true })
b.sayHi() // 报错：方法不存在
b.doStuff() // 正常访问
console.log(b.param1) // 报错：属性不存在

问题原因 #

• 声明文件导出错误：声明文件中export default TronWeb是笔误，未正确导出类A，导致外部项目无法识别父类类型。
• 类型声明未被正确发布：自研库编译生成的.d.ts文件未通过package.json的types字段指定，或未被包含在发布包中，外部项目无法读取父类类型定义。
• 子类声明未正确继承父类类型：若编译后类B的.d.ts文件未正确关联父类A的类型，也会导致外部无法识别继承成员。

解决方案 #

1. 修正声明文件的导出错误 #

将external-lib.d.ts中的默认导出修正为类A：

/// <reference types="node" />
declare module 'external-lib' {
    export class A {
        param1: string
        param2: string

        sayHi(): void
        constructor(e: any)
    }

    export default A; // 修正为正确的默认导出
}

2. 确保类型声明被正确发布 #

• 在自研库的package.json中添加types字段，指向生成的主声明文件：

  {
    "types": "dist/index.d.ts",
    "main": "dist/index.js"
  }
  

• 保持tsconfig.json的declaration字段为true，确保编译时生成.d.ts文件。
• 检查.npmignore配置，不要排除dist目录下的.d.ts文件，保证发布包包含类型声明。

3. 验证子类的声明文件 #

编译后查看dist目录下类B对应的.d.ts文件，确认它正确继承了A的类型：

import A from 'external-lib';
export declare class B extends A {
    constructor(options: any[]);
    doStuff(): void;
}

若未正确继承，检查tsconfig.json的include配置是否包含lib/typings目录，确保编译时能读取外部库的类型声明。

4. 外部项目类型解析配置 #

外部项目使用该库时，确保tsconfig.json的skipLibCheck为false（或不设置），避免跳过自研库的类型检查。无需在外部项目中重复添加external-lib的类型声明。

内容的提问来源于stack exchange，提问作者Denys Rybkin