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

Question

我正在创建一堆 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 中的类型？

Answer 1

如果没有映射，您无法真正将字符串转换为类型。事实上，除了作为 type 参数传递给 addEventListener() 的实际字符串之外，您一开始真的不需要这些字符串。看起来您真正想要的是 namespaces or modules 之类的东西来组织您的类型。

例如，使用命名空间我们可以获得与您的 EVENTS 对象类似的内容，不同之处在于它不是仅引用字符串值，而是引用字符串值 and类型：

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.detail <b>Type</b>s.SliderChanged<b>DetailType</b>), 但这里的主要思想是使用命名空间或模块的一般方法。

希望对您有所帮助；祝你好运！

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

Typescript: How to convert a string to a type

types

casting

custom-events

typescript