如何在 typescript 中扩展其他模块的类型

Question

我正在使用 ts 编写一个库，在尝试扩展核心模块类型时遇到了一些麻烦。 这是项目结构。

- src
  - core
    - core.ts
  - plugins
    - insert
      - index.ts

core.ts中的代码

export interface Commands {}

export class Core {
  commands: Commands;

  constructor() {
    this.commands = {};
  }

  registerCommands(name: string, func: any) {
    // @ts-ignore
    this.commands[name] = func;
  }
}

insert/index.ts中的代码

import { Core } from "../../core/core";

export class InsertPlugin {
  constructor(core: Core) {
    core.registerCommands("insert", this.insert.bind(this));
  }

  insert(value: string) {
    console.log("insert " + value);
  }
}

InsertPlugin使用core.registerCommands将命令insert注册到核心。

我的问题是使用我的库的人如何获取insert命令的类型。 例如

// assume the name of the library is core
import { createCore } from 'core'

const core = createCore()
// How can i get types for insert method
core.commands.insert()

我已经为上述代码创建了一个完整的演示https://github.com/clinyong/ts-extends-core-commands 。

我还阅读了 typescript 插件类型手册， https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-plugin-d-ts.ZFC35FDC70D5FC69D269883A 。

Answer 1

您的示例有趣的是，访问core.commands.insert()仅在您创建new InsertPlugin(core)实例后才有效（您在示例中没有这样做）。

鉴于此，如果您要使用带有断言返回类型的 function 而不是 class，则实际上可以编码此要求。

insert/index.ts ：

import { Core } from "../../core/core";

function registerInsertPlugin(core: Core): asserts core is (Core & {
  commands: {
    insert: typeof insert
  }
}) {

  const insert = (value: string) => {
    console.log("insert " + value);
  }

  core.registerCommands("insert", insert);
}

然后你可以像这样使用它：

import { createCore } from 'core'
import { registerInsertPlugin } from 'insert'

const core = createCore();
registerInsertPlugin(core);
core.commands.insert('hello world');

忘记调用registerInsertPlugin将导致有效类型错误：

import { createCore } from 'core'

const core = createCore();
core.commands.insert('hello world');
// ^ Property 'insert' does not exist on type 'Commands'

除此之外，您还可以创建多个“插件”，每个插件都将使用相关类型扩展core.commands ：

const core = createCore();
registerInsertPlugin(core);
registerUpsertPlugin(core);
core.commands.insert('hello world');
core.commands.upsert("hello world");

/* Resulting Type:
 * const core: Core & {
 *     commands: {
 *         insert: (value: string) => void;
 *     };
 * } & {
 *     commands: {
 *         upsert: (value: string) => void;
 *     };
 * }
 */