使用TypeScript和EventEmitter键入事件

时间:2017-05-09 16:42:24

标签: generics typescript eventemitter

我正在尝试使用TypeScript将强类型事件添加到类似EventEmitter的系统中。

目前,我们定义了类似的类型:

interface TypedMsg<Name, T> {
  messageType: Name;
  message: T;
}

type TypedMsgFoo = TypedMsg<'FOO', string>;
type TypedMsgBar = TypedMsg<'BAR', number>;
type EitherFooOrBar = TypedMsgFoo | TypedMsgBar;

我想定义一个类似的界面:

interface EventHandler<T extends TypedMsg<any, any> {
  on: (messageType: T.messageType, handler: (T.message) => void) => void;
}

但是Typescript不支持提取像T.messageType这样的子类型。还有另一种方法吗?

最终目标是使用正确的键入来定义处​​理程序:

class FooBarHandler implements EventHandler<EitherFooOrBar> {
  on(messageType: EitherFooOrBar.messageType) {...}
}

1 个答案:

答案 0 :(得分:5)

Typescript确实支持提取成员类型,只是语法有点不寻常 - 它被称为indexed access type operator

interface TypedMsg<Name, T> {
  messageType: Name;
  message: T;
}

type TypedMsgFoo = TypedMsg<'FOO', string>;
type TypedMsgBar = TypedMsg<'BAR', number>;
type EitherFooOrBar = TypedMsgFoo | TypedMsgBar;

interface EventHandler<T extends TypedMsg<{}, {}>> {
  on: (messageType: T['messageType'], handler: (m: T['message']) => void) => void;
}

class FooBarHandler implements EventHandler<EitherFooOrBar> {
    on(
        messageType: EitherFooOrBar['messageType'], 
        handler: (m: EitherFooOrBar['message']) => void
    ) {

    }
}

然而,用明确拼写出的类型输入所有这些声明很快就会变得非常繁琐 - 你会想要设计一些允许打字稿为你推断类型的东西,例如像这样的问题:TypeScript type inference/narrowing challenge < / p>