全部 / 前端 / 技术 · 2024年5月18日 0

TS – declare module vs declare namespace

1716045749

在TypeScript中,declare moduledeclare namespace 都用于定义类型信息供编译器使用,但它们之间存在一些关键差异,主要体现在组织结构和用途上:

declare module

  • 用途: declare module 主要用于描述一个外部模块(通常是第三方库)的类型信息。当你使用的JavaScript库没有自带类型定义文件(.d.ts),你可以通过这种方式来声明这个模块提供的接口,以便在TypeScript项目中使用这些库而不会引发类型错误。

  • 组织结构: 它强调的是模块的边界,允许你为整个模块或模块内的特定部分(如类、接口、函数等)提供类型声明。

  • 示例:

    declare module 'myModule' {
        export function doSomething(): void;
        export class MyClass {
            constructor();
            someMethod(): string;
        }
    }
    

declare namespace

  • 用途: declare namespace 则更多用于创建一个逻辑上的命名空间,用来组织相关的类型、类、接口等。命名空间可以帮助避免全局变量的污染,并提供一种层次化的访问方式。它是TypeScript中组织代码的一种方式,尤其是对于那些没有采用ES6模块化(import/export)的老式JavaScript代码。

  • 组织结构: 命名空间可以嵌套,形成一种树状结构,有助于管理大型项目中的类型定义,避免命名冲突。

  • 示例:

    declare namespace MyLibrary {
        export class Utility {
            static formatText(text: string): string;
        }
    
        export namespace Network {
            export function fetchData(url: string): Promise<any>;
        }
    }
    

总结

  • 当你需要描述一个外部模块的类型时,应该使用 declare module
  • 如果你的目标是组织内部的类型定义,或者为一个较大的代码库创建逻辑分组,那么 declare namespace 更为合适。

随着现代JavaScript和TypeScript倾向于使用ES模块系统,namespace的使用逐渐减少,尤其是在新项目中,更多的推荐直接使用模块导入导出(import/export)来代替命名空间来组织代码。然而,在某些场景下,比如维护旧代码库或与遗留代码集成时,namespace仍然有用武之地。