是否可重新声明d.ts模块以覆盖npm包自带的类型声明?
可以覆盖npm包自带的.d.ts声明文件,你遇到的不生效问题是类型声明优先级和解析规则导致的,按照以下步骤配置即可无需修改node_modules内的文件:
第一步:确保自定义声明文件被识别
打开项目根目录的tsconfig.json(JavaScript项目对应jsconfig.json),在include字段中加入你存放自定义.d.ts文件的目录路径,示例配置:{ "include": ["src/**/*", "src/types/**/*"] }同时检查
exclude字段,不要将该自定义声明目录配置到排除规则中。第二步:使用正确的模块扩充语法编写自定义声明
不能直接重新声明类/类型,需要对应包的暴露方式写声明覆盖逻辑:- 如果
FooClass是从npm包(假设包名为foo)中导出的,自定义foo.d.ts写法如下:
declare module 'foo' { // 其他不需要修改的原有类型无需重写,会自动继承原包声明 declare class FooClass { get foo(): boolean; } export { FooClass }; }- 如果
FooClass是全局暴露的变量,自定义foo.d.ts写法如下:
declare global { declare class FooClass { get foo(): boolean; } } // 加该行将文件标记为模块,避免全局声明失效 export {}- 如果
第三步:配置优先级强制优先加载自定义声明
如果上述操作后仍不生效,在compilerOptions中添加paths配置,直接指定对应包的声明文件路径:{ "compilerOptions": { "paths": { "foo": ["./src/types/foo.d.ts"] } } }
内容的提问来源于stack exchange,提问作者Enzo Manuel Mangano
相关产品推荐
相关产品推荐

