打字稿:如何将字符串转换为类型

时间:2019-01-10 16:42:32

标签: typescript types casting custom-events

我正在创建一堆Web组件,并且每个组件都可以发出自定义事件。作为一个示例,下面是两个简单的示例:

//MyButton
emits 'myButtonPressed' and detail of this type:
interface ButtonDetailType {
  id: string;
}

//MySlider
emits 'mySliderChanging' and details of this type:
interface SliderChangingDetailType {
  id: string;
  value: number;
}
emits 'mySliderChanged' and details of this type:
interface SliderChangedDetailType {
  id: string;
  oldValue: number;
  newValue: number;
}

要收听这些组件,我的代码如下:

buttonEl.addEventListener( 'myButtonPressed', ( event : CustomEvent ) => {
  const detail = event.detail as ButtonDetailType;
  //now i have access to detail.id
} );

sliderEl.addEventListener( 'mySliderChanging', ( event : CustomEvent ) => {
  const detail = event.detail as SliderChangingDetailType;
  //now i have access to detail.id, detail.value
} );

在制作更多组件时,我很难记住每个组件可以发出的所有自定义事件名称或每个事件生成的detailType。

为解决此问题,我希望创建一个包含所有此类信息的对象:

EVENTS = {
  button: {
    myButtonPressed: 'myButtonPressed',
    detailType: 'ButtonDetailType',
  },
  slider: {
    mySliderChanged': 'mySliderChanged',
    detailTypes: {
     'SliderChangedDetailType',
     'SliderChangingDetailType',
    }
  }
};

有了这一点,我现在有了一种简单的方法来访问每个组件的所有事件名称,并在输入时自动完成自动地帮助我完成

buttonEl.addEventListener( EVENTS.button. //autocomplete shows me all event names here! YAY!
sliderEl.addEventListener( EVENTS.slider. //autocomplete here too!

我遇到的问题是我不知道如何将字符串转换为类型。我希望能够输入以下内容:

buttonEl.addEventListener( EVENTS.button.myButtonPressed, ( event : CustomEvent ) => {
  const detail = event.detail as EVENTS.button.detailType; // <- invalid: EVENTS.button.detailType is a string not a type!
} );

有没有一种方法可以将字符串转换为TypeScript中的类型?

1 个答案:

答案 0 :(得分:4)

如果没有映射,就无法真正将字符串转换为类型。实际上,除了将实际字符串作为addEventListener()参数传递到type之外,您实际上根本不需要这些字符串。看来您真正想要的是类似namespacesmodules的东西来组织您的类型。

例如,使用命名空间,我们可以获得类似于EVENTS对象的东西,除了它不仅引用字符串值,还引用字符串值类型:

namespace EVENTS {
  export namespace button {
    export const myButtonPressed = "myButtonPressed";
    export namespace detailType {
      export interface ButtonDetailType {
        id: string;
      }
    }
  }
  export namespace slider {
    export const mySliderChanged = "mySliderChanged";
    export namespace detailTypes {
      export interface SliderChangingDetailType {
        id: string;
        value: number;
      }
      export interface SliderChangedDetailType {
        id: string;
        oldValue: number;
        newValue: number;
      }
    }
  }
}

这应该为您提供与以前相同的自动完成功能,以及以下类型的自动完成功能:

buttonEl.addEventListener(EVENTS.button.myButtonPressed, ((event: CustomEvent) => {
  const detail = event.detail as EVENTS.button.detailType.ButtonDetailType;
}) as EventListener);

sliderEl.addEventListener(EVENTS.slider.mySliderChanged, ((event: CustomEvent) => {
  const detail = event.detail as EVENTS.slider.detailTypes.SliderChangedDetailType;
}) as EventListener)

要更改事物的嵌套和命名级别由您自己决定,因为名称空间会使某些事物变得多余(也许您想用EVENTS.slider.details.SliderChanged而不是EVENTS.slider.detailTypes.SliderChangedDetailType),但是这里的主要思想是是使用名称空间或模块的通用方法。

希望有所帮助;祝你好运!