typescript 限制对象属性的数量

Question

是否可以限制对象属性的数量，比如我想限制对象只有一个字符串属性(任意名称)，我可以这样做:

{[index: string]: any}

可以限制属性的类型，但是可以限制属性的数量吗？

Answer 1

这个问题在 Stackoverflow 上有很多答案(包括 this detailed one )，但没有一个适合我的情况，这与此处发布的情况类似。

问题

我有一个接受对象的函数。如果传递的对象没有一个键，我希望它抛出一个编译错误 (Typescript)。例如

f({}); // Must error here, as it has less than one key!
f({ x: 5 });
f({ x: 5, y : 6 }); // Must error here, as it has more than one key!

---

解决方案

使用流行的 UnionToIntersection和 IsUnion ，我通过以下实用函数实现了它。

type SingleKey<T> = IsUnion<keyof T> extends true ? never : {} extends T ? never : T;

完整代码:

// From https://stackoverflow.com/a/50375286
type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;

// From: https://stackoverflow.com/a/53955431
type IsUnion<T> = [T] extends [UnionToIntersection<T>] ? false : true;

// Here we come!
type SingleKey<T> = IsUnion<keyof T> extends true ? never : {} extends T ? never : T;

// Usage:
function f<T extends Record<string, any>>(obj: SingleKey<T>) {
    console.log({ obj });
}

f({}); // errors here!
f({ x: 5 });
f({ x: 5, y : 6 }); // errors here!

Playground Link