TypeScript：覆盖和修复包的类型定义

IT技术 reactjs typescript typescript-typings victory-charts
2021-05-06 10:33:45

我正在使用React 胜利库制作图表，我正在使用 TypeScript。我已将@types/victory包添加到我的项目中，但不幸的是，它缺少一些我需要的关键定义。对于某些接口，它缺少几个属性，因此（使用此答案），我创建了一个自定义文件以将这些属性添加到接口。

但是，现在我有一个问题：为事件定义的接口有一个名为eventHandlersdefined的属性，但它又缺少一个重要的定义，它是如何定义的：

export interface EventPropTypeInterface<TTarget, TEventKey> {
  /* other properties */,
  eventHandlers: {
    [key: string]:
      { (event: React.SyntheticEvent<any>): EventCallbackInterface<TTarget, TEventKey> } |
      { (event: React.SyntheticEvent<any>): EventCallbackInterface<TTarget, TEventKey>[] }
  }

但是，问题是该函数应该允许接受第二个参数，例如（我不确定第二个参数的类型，所以我有any）：

{ (event: React.SyntheticEvent<any>, dataPoint: any): EventCallbackInterface<TTarget, TEventKey> }

所以，我试图在我自己的定义中包含这个属性：

declare module "victory" {
  export interface EventPropTypeInterface<TTarget, TEventKey> {
  eventHandlers: {
    [key: string]:
      { (event: React.SyntheticEvent<any>, dataPoint: any): EventCallbackInterface<TTarget, TEventKey> } |
      { (event: React.SyntheticEvent<any>, dataPoint: any): EventCallbackInterface<TTarget, TEventKey>[] }
  }
}

但现在，typescript被抱怨index.d.ts的@typings目录，说eventHandlers一定是我定义的类型。

有没有办法使用提供的类型定义文件并以某种方式使用我自己的定义“增强”它，类似于我在添加新属性时对其他接口所做的操作？

1个回答

这可以工作。问题在于定义类型时没有考虑到可扩展性。

对象字面量类型，例如{x: string}在许多情况下都很好，但不适用于复杂的嵌套结构。

其原因是这些类型，类似于类型别名，是不是受到启用扩展所需的申报合并。

如果eventHandlers对象的可能值的类型被声明为 an，interface它可以通过简单地添加额外的重载来轻松扩展。

下面的自包含示例显示了当类型被重构为使用interface值类型的声明时，可扩展性是多么容易eventHandlers：

declare module "victory" {
    interface EventHandler<TTarget, TEventKey> {
        (event: React.SyntheticEvent<any>): EventCallbackInterface<TTarget, TEventKey>
        (event: React.SyntheticEvent<any>): EventCallbackInterface<TTarget, TEventKey>[]
    }

    export interface EventPropTypeInterface<TTarget, TEventKey> {
        eventHandlers: {
            [key: string]: EventHandler<TTarget, TEventKey>

        }
    }
}
declare module "victory" {
    // this interface merges with the original, declaring additional overloads of the all signature
    interface EventHandler<TTarget, TEventKey> {
        // declare overloads
        (event: React.SyntheticEvent<any>, dataPoint: any): EventCallbackInterface<TTarget, TEventKey>
        (event: React.SyntheticEvent<any>, dataPoint: any): EventCallbackInterface<TTarget, TEventKey>[]
    }
}

type EventCallbackInterface<T, U> = {}
declare namespace React {
    export type SyntheticEvent<T> = {};
}

测试：

import victory = require("victory");

declare const handlerProps: victory.EventHandler<{}, {}>;

handlerProps({}, { x: 1, y: 2 }); // works fine

这是一个链接到它在行动

我强烈建议您向https://github.com/DefinitelyTyped/DefinitelyTyped提交拉取请求，该请求修改npm:@types/victory为interface以这种方式使用 以启用这种可扩展性。

其它你可能感兴趣的问题
上一篇React Hooks 如何使用Callback“冻结”闭包？ 下一篇React/Redux 中的通用 Reducers/Actions