typescript - 如何将方法的泛型类型限制为 typescript 中的对象？

Question

我一直试图为我的方法提出一个泛型类型，并将该类型限制为具有以下要求的对象。
下面是我正在使用的功能。然而，这个函数在 React 应用程序的自定义钩子(Hook)中使用。

function useCustomHook<T>(initialData: T[]) {
  const [changes, setChanges] = React.useState<T[]>([])

  // calling the method inside the hook with an element should be retrieved from changes
  doSomething() 
}

function doSomething<T>(obj: T) {
  Object.entries(obj).forEach(([key, value]) => {
    console.log(key, value)
  })
}

// Type
type ExampleType = {
  property1: number,
  property2: string
}
// Interface
interface ExampleInterface {
  property1: number;
  property2: string;
}

它应该为以下示例抛出错误(基本上它不应该接受任何原始类型，例如字符串、数字、 bool 值、空值、未定义……):

doSomething('test')
doSomething(12)
doSomething(undefined)

它应该接受以下示例:

doSomething({})
doSomething({ property1: 12, property2: 'string'})


doSomething<ExampleType>({ property1: 12, property2: 'string'})
doSomething<ExampleInterface>({property1: 12, property2: 'string'})

我已经尝试过像这样更改方法:
函数 doSomething 扩展记录<字符串，未知> >
它适用于大多数示例(意味着它会抛出错误)，但在使用接口(interface)时不起作用(抛出索引签名丢失)。将现有接口(interface)更改为类型不是解决方案，我认为如果示例函数是库的一部分，我作为库的用户希望同时拥有选项 - 接口(interface)和类型。
但是，如果我将 unknown 更改为 any 但我相信在 Typescript 中应避免使用 any ，则它会起作用。
我将不胜感激任何建议。我相信一定有办法实现它。这是沙箱: https://codesandbox.io/s/sweet-wildflower-hqr1t

Answer 1

正确的做法是到 constrain类型参数 T至 the object type ，具体表示“不是原始类型的类型”:

function doSomething<T extends object>(obj: T) {
  Object.entries(obj).forEach(([key, value]) => {
    console.log(key, value)
  })
}

您可以验证它是否以这种方式工作:

doSomething('test'); // error
doSomething(12); // error
doSomething(undefined); // error
doSomething({}) // okay
doSomething({ property1: 12, property2: 'string'}) // okay
doSomething<ExampleType>({ property1: 12, property2: 'string'}) // okay
doSomething<ExampleInterface>({property1: 12, property2: 'string'}) // okay

这正是 object type 是在 TypeScript 中使用的，以及它存在的原因。

现在，在这一点上，我期待您使用 ESLint's ban-types rule 时的响应。使用默认配置，它会提示 object带有以下形式的警告:

Avoid the object type, as it is currently hard to use due to not being able to assert that keys exist. See microsoft/TypeScript#21732.

此规则在某些情况下可能是善意和有用的，并且 object确实有一些缺点，但正如您所见， Record<string, unknown>并不总是一种改进。某些东西“难以使用”大概并不意味着它应该被完全禁止以支持其他东西，特别是如果其他东西不适用于用例。用刀很难打开 jar 头，您可能应该改用开 jar 器，但这并不意味着您应该尝试用开 jar 器切面包。不同的类型有不同的用例。和 T extends object在上面的代码中似乎 100% 是这项工作的正确工具。
我可能对这个问题有点情绪化，因为我是提交 microsoft/TypeScript#21732 的人。 , 我很想看看 key in obj在 obj 上充当类型保护断言属性(property)存在。但是 that issue absolutely does not mean that object is useless ，看到其他项目中的所有 GitHub 问题都与此相关联，这是他们仔细切除的原因，这有点令人筋疲力尽 object从他们的代码。
那好吧!
Playground link to code