UNPKG

2.05 kBTypeScriptView Raw
1/**
2Convert a union type to an intersection type using [distributive conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
3
4Inspired by [this Stack Overflow answer](https://stackoverflow.com/a/50375286/2172153).
5
6@example
7```
8import type {UnionToIntersection} from 'type-fest';
9
10type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};
11
12type Intersection = UnionToIntersection<Union>;
13//=> {the(): void; great(arg: string): void; escape: boolean};
14```
15
16A more applicable example which could make its way into your library code follows.
17
18@example
19```
20import type {UnionToIntersection} from 'type-fest';
21
22class CommandOne {
23 commands: {
24 a1: () => undefined,
25 b1: () => undefined,
26 }
27}
28
29class CommandTwo {
30 commands: {
31 a2: (argA: string) => undefined,
32 b2: (argB: string) => undefined,
33 }
34}
35
36const union = [new CommandOne(), new CommandTwo()].map(instance => instance.commands);
37type Union = typeof union;
38//=> {a1(): void; b1(): void} | {a2(argA: string): void; b2(argB: string): void}
39
40type Intersection = UnionToIntersection<Union>;
41//=> {a1(): void; b1(): void; a2(argA: string): void; b2(argB: string): void}
42```
43
44@category Type
45*/
46export type UnionToIntersection<Union> = (
47 // `extends unknown` is always going to be the case and is used to convert the
48 // `Union` into a [distributive conditional
49 // type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
50 Union extends unknown
51 // The union type is used as the only argument to a function since the union
52 // of function arguments is an intersection.
53 ? (distributedUnion: Union) => void
54 // This won't happen.
55 : never
56 // Infer the `Intersection` type since TypeScript represents the positional
57 // arguments of unions of functions as an intersection of the union.
58) extends ((mergedIntersection: infer Intersection) => void)
59 // The `& Union` is to allow indexing by the resulting type
60 ? Intersection & Union
61 : never;