Question

我有一个采用通用类型的函数，我需要确保该类型是JSON可序列化的（又称原始属性）。

我的尝试是为JSON兼容类型定义一个接口，并强制我的泛型扩展此类型：

type JSONPrimitive = string | number | boolean | null
interface JSONObject {
  [prop: string]: JSONPrimitive | JSONPrimitive[] | JSONObject | JSONObject[]
}
export type JSONable = JSONObject | JSONPrimitive | JSONObject[] | JSONPrimitive[]

function myFunc<T extends JSONable>(thing: T): T {
  ...
}

// Elsewhere

// I know that if this was defined as a `type` rather than
// an `interface` this would all work, but i need a method
// that works with arbitrary types, including external interfaces which
// are out of my control
interface SomeType {
  id: string,
  name: string
}

myFunc<SomeType[]>(arrayOfSomeTypes)
// The above line doesn't work, i get: 
// Type 'SomeType[]' does not satisfy the constraint 'JSONable'.
//   Type 'SomeType[]' is not assignable to type 'JSONObject[]'.
//     Type 'SomeType' is not assignable to type 'JSONObject'.
//       Index signature is missing in type 'SomeType'.ts(2344)

这里的问题似乎归结于打字稿中索引签名的工作方式。具体地说，如果类型缩小了索引签名允许的可能属性，则它不能扩展具有索引签名的类型。（即SomeType不允许您随意添加foo属性，但是当然可以使用JSONable。此问题在existing github issue中有进一步说明。

所以我知道上面的方法并没有真正起作用，但是问题仍然存在，我需要一些可靠的方法来确保泛型类型是JSON可序列化的。有什么想法吗？

谢谢！

Answer 1

我可能会在此处进行操作（在没有修复或更改underlying issue around implicit index signatures in interfaces的情况下）的方式是将所需的json类型表示为类似这样的通用约束：

Players: [Adam: 1, Bob: 0, Cameron: 2, Daniel: 2]
Sorted Players: [Bob: 0, Adam: 1, Cameron: 2, Daniel: 2]
Winners: [Cameron: 2, Daniel: 2]

因此，如果type AsJson<T> = T extends string | number | boolean | null ? T : T extends Function ? never : T extends object ? { [K in keyof T]: AsJson<T[K]> } : never;是有效的JSON类型，则AsJson<T>应该等于T，否则它的定义中将有T。然后我们可以这样做：

never

要求declare function myFunc<T>(thing: T & AsJson<T>): T;为thing（为您推断T）与T相交，并添加AsJson<T>作为对AsJson<T>的附加约束。让我们看看它是如何工作的：

thing

现在您的接口类型已被接受：

myFunc(1); // okay
myFunc(""); // okay
myFunc(true); // okay
myFunc(null); // okay

myFunc(undefined); // error
myFunc(() => 1); // error
myFunc(console.log()); // error

myFunc({}); // okay
myFunc([]); // okay
myFunc([{a: [{b: ""}]}]); // okay

myFunc({ x: { z: 1, y: () => 1, w: "v" } }); // error!
//  --------------> ~
//  () => number is not assignable to never

好的，希望能有所帮助。祝你好运！

Link to code

确保泛型类型在Typescript中仅具有原始属性

1 个答案: