【问题标题】:In Typescript, how to use a string type union to constraint a key from another type or interface在 Typescript 中,如何使用字符串类型联合来约束另一个类型或接口的键
【发布时间】:2019-07-19 08:37:50
【问题描述】:

如果我有:

type Op = 'AND' | 'OR';

我知道我会写:

type Exp<T> = {
   [_ in Op]: T[];
};

使得以下所有行都有效

let a: Exp<number> = { OR: [4] };
let b: Exp<number> = { AND: [5] };
let c: Exp<number> = { AND: [1], OR: [2, 3] };

我的问题是,我可以这样写吗,ab 有效,但 c 无效?即只允许一个密钥,密钥类型为Op

即使我像这样迭代所有 Op 类型:

type Exp<T> = { AND: T[] } | { OR: T[] };

它仍然不会做我想让它做的事情。我猜是因为声明合并?

对打字稿很陌生。寻找一种优雅的方式来表达这一点。

【问题讨论】:

  • 是的,有可能我会发布解决方案

标签: javascript typescript types


【解决方案1】:

有几种不同的方法可以实现您想要的,哪种方法最好取决于您的实际用例,我无法从示例中得出。

这些是实现您想要的一些方法。

方式 1:传递密钥。

type Exp<T, K extends Op> = Record<K, T[]>

let a: Exp<number, "OR"> = { OR: [4] }; //pass
let b: Exp<number, "AND"> = { AND: [5] }; //pass
let c: Exp<number, "And"> = { AND: [1], OR: [2, 3] }; //fail
let c: Exp<number, Op> = { AND: [1], OR: [2, 3] }; // pass

方式 2:使 OP 的每个键都成为 XOR 在这种情况下,您不再需要传递密钥。

export type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
export type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };

type Op = 'AND' | 'OR';

type Exp<T> = XOR<Pick<Record<Op, T[]>, "AND">, Pick<Record<Op, T[]>, "OR">>

let a: Exp<number> = { OR: [4] }; //pass
let b: Exp<number> = { AND: [5] }; //pass
let c: Exp<number> = { AND: [1], OR: [2, 3] }; //fail

方式 3:请注意,这是自动生成的版本,它并不漂亮,我这样做只是为了显示它是可能的。这个解决方案不能在没有重载的情况下达到无限深度,这是因为联合不能被迭代但是这表明它到深度九。我发布这个只是因为它引起了人们的兴趣。

// add an element to the end of a tuple
type Push<L extends any[], T> =
  ((r: any, ...x: L) => void) extends ((...x: infer L2) => void) ?
  { [K in keyof L2]-?: K extends keyof L ? L[K] : T } : never

// convert a union to an intersection: X | Y | Z ==> X & Y & Z
type UnionToIntersection<U> =
  (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never

// convert a union to an overloaded function X | Y ==> ((x: X)=>void) & ((y:Y)=>void)     
type UnionToOvlds<U> = UnionToIntersection<U extends any ? (f: U) => void : never>;

// convert a union to a tuple X | Y => [X, Y]
// a union of too many elements will become an array instead
type UnionToTuple<U> = UTT0<U> extends infer T ? T extends any[] ?
  Exclude<U, T[number]> extends never ? T : U[] : never : never

// each type function below pulls the last element off the union and 
// pushes it onto the list it builds
type UTT0<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT1<Exclude<U, A>>, A> : []
type UTT1<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT2<Exclude<U, A>>, A> : []
type UTT2<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT3<Exclude<U, A>>, A> : []
type UTT3<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT4<Exclude<U, A>>, A> : []
type UTT4<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT5<Exclude<U, A>>, A> : []
type UTT5<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT6<Exclude<U, A>>, A> : []
type UTT6<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT7<Exclude<U, A>>, A> : []
type UTT7<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT8<Exclude<U, A>>, A> : []
type UTT8<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTT9<Exclude<U, A>>, A> : []
type UTT9<U> = UnionToOvlds<U> extends ((a: infer A) => void) ? Push<UTTX<Exclude<U, A>>, A> : []
type UTTX<U> = []; // bail out

export type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
export type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };

type DeepXOR<Obj, T extends any[]> = {
    [K in keyof T]: T[K] extends keyof Obj
        ? XOR<Pick<Obj, T[K]>, ((..._: T) => any) extends ((_: any, ..._1: infer TAIL) => any)
            ? DeepXOR<Obj, TAIL>[0] extends never
                ? never
                : DeepXOR<Obj, TAIL>[0]
            : never
            >
        : never;
};


interface Person {
    name: string;
    age: number;
    dob: Date;
}


type PersonXOR = DeepXOR<Person, UnionToTuple<keyof Person>>[0]

const test: PersonXOR = {name: "shanon"}; // pass
const test1: PersonXOR = {age: 24}; // pass
const test2: PersonXOR = {dob: new Date()}; // pass
const test3: PersonXOR = {name: "shanon", dob: new Date()} // fail

编辑方式4:

@dragomirtitian 提醒我,您实际上可以通过连接每个对象/键对(单数对)并将其与其他对的一部分相交并将其类型值设置为从不来创建一个严格的联合。可能是最干净的方法

type Op = 'AND' | 'OR' | "NOT";


type Exp<T> = Op extends infer D ?
    D extends any ? {
   [_ in D]: T[];
}: never : never;

type UnionKeys<T> = T extends any ? keyof T : never;
type StrictUnionHelper<T, TAll> = T extends any ? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, never>> : never;
type StrictUnion<T> = StrictUnionHelper<T, T>

let a: StrictUnion<Exp<number>> = { OR: [4] }; // no error
let b: StrictUnion<Exp<number>> = { AND: [5] }; // no error
let c: StrictUnion<Exp<number>> = { AND: [1], OR: [2, 3] }; // error

【讨论】:

  • 我喜欢。谢谢。
  • 请注意,也可以为每个键自动生成 XOR
  • 我也在玩这个想法,并且有两个以上的操作。很想看看你会怎么做。你似乎非常擅长这个。
  • 编辑:抱歉发布了一个编辑到最后一行搞砸的编辑
  • 这将需要我更长的时间来消化,但这很酷。再次感谢。
猜你喜欢
  • 2019-06-27
  • 1970-01-01
  • 2021-07-04
  • 1970-01-01
  • 1970-01-01
  • 2019-03-20
  • 2021-11-01
  • 2019-01-12
  • 1970-01-01
相关资源
最近更新 更多