node.js - 如何在 TypeScript 中正确设计 API 模块？

我想设计一个用于访问外部信息系统的 TypeScript (2.7) 模块，我们称它为 InfoSys。我使用了以下方法。

我创建了 info-sys.ts，它定义了一个 API 类以及相关的接口和枚举，例如：

class Api {
    constructor(private endpoint: Endpoint) {
        // ...
    }
}

enum Endpoint {
    CONTACTS = "contacts"
}

interface Contact {
    name: string;
}

现在我想导出特定名称下的所有内容。所以我添加了导出语句：

export const InfoSys = {
    Api,
    Endpoint,
    Contact
};

当我尝试在另一个文件中使用该模块时，比如：

import { InfoSys } from "info-sys";

// this line throws error: "Cannot find namespace 'InfoSys'"
private api: InfoSys.Api;

// but this line is ok
api = new InfoSys.Api(InfoSys.Endpoint.CONTACTS);

具体操作方法如下——逐个导出每个部分：

export class Api {
    constructor(private endpoint: Endpoint) {
        // ...
    }
}

export enum Endpoint {
    CONTACTS = "contacts"
}

export interface Contact {
    name: string;
}

并将它们全部导入到一个变量中：

import * as InfoSys from "info-sys";

但是变量的名称可以随意。它对功能并不关键，但我想强制使用信息系统模块的开发人员在访问它时使用特定的名称（以便更容易阅读和维护）。如何正确设计这样的模块？

答案＃1

你可以使用 namespace:

export namespace InfoSys {
  Api,
  Endpoint,
  Contact
};

一般来说，这种方法应该避免。但在你的情况下是可以的，因为你交付的内容是紧密相关的。

如果 Api 是所有这些的唯一入口点，我也会推荐这个：

export class InfoSysApi { ... }
export namespace InfoSysApi {
  export enum Endpoint = { ... }
  export interface Contact { ... }
}  

更新：为了确保我能传达清楚，请不要做以下事情：

export namespace Foo {
  export function X() { return 'x' }
  export function Y() { return 'y' }
}

仅使用 export namespace 来导出“引用的类型”，而不是值。

在 TypeScript 手册中: https://www.typescriptlang.org/docs/handbook/declaration-merging.html

虽然表格上说命名空间可以包含值，但如果你在编写 ESM（import/export），这被认为是不好的做法。

命名空间和 ESM 是实现类似结果的两种不同机制。不要将它们混在一起。