TypeScript:EventEmitter子类事件的专用签名

时间:2016-03-01 23:16:29

标签: events typescript overloading typescript1.8

我有一个基类EventEmitter,它有on方法来绑定特定事件的处理程序:

class EventEmitter {
    on(event: string, handler: Function) {
        /* add handler internally */
    }

    protected emit(event: string, ...args) {
        /* call all handlers listening on event */
    }
}

现在我有各种子类,它们可以使用不同的参数发出不同的事件。我想“声明”该特定类可以发出哪些事件:

class MyClass extends EventEmitter {
    on(event: 'event1', handler: (arg1: number) => void): void;
    on(event: 'event2', handler: (arg1: string, arg2: number) => void): void;
}

所以我的子类可能会发出事件event1event2,但这似乎不是正确的指定方式。 TypeScript(tsc 1.8)正在补充:

error TS2415: Class 'MyClass' incorrectly extends base class 'EventEmitter'.
  Types of property 'on' are incompatible.
Type '(event: "event1", handler: (arg1: number) => void) => void' is not assignable to type '(event: string, handler: Function) => void'.
  Type '(event: "event1", handler: (arg1: number) => void) => void' provides no match for the signature '(event: string, handler: Function): void'
error TS2382: Specialized overload signature is not assignable to any non-specialized signature.
error TS2391: Function implementation is missing or not immediately following the declaration.

那么,指定我的类可以发出的事件的目的是什么?

编辑:我找到了我要找的名字:Specialized Signatures。但是,它似乎只适用于接口,而不适用于新的TypeScript代码。

现在我发现anothother question关于2015年的同一问题,但是那里的解决方案看起来不太合适。那么,今天在TypeScript中还有其他方法吗?

1 个答案:

答案 0 :(得分:2)

  

指定我的类可以发出的事件的预期方式是什么?

不是使用包含所有类型的单个事件流,而是更容易为每个创建单独的事件流/ em>类型。

这是我称之为TypedEvent的概念。使用它的一个示例项目是http://alm.tools/

实施:https://github.com/alm-tools/alm/blob/55a8eb0f8ee411a506572abce92085235658b980/src/common/events.ts#L20-L72

以下是一个示例用法:https://github.com/alm-tools/alm/blob/55a8eb0f8ee411a506572abce92085235658b980/src/server/lang/errorsCache.ts#L10

export let errorsUpdated = new TypedEvent<ErrorsUpdate>();
// emit: 
errorsUpdated.emit({} /* this will be type checked */);
// consume:
errorsUpdated.on((x)=>null); // x has the correct inferred type