Sha256: eb1625bab70cfed00931a1e09ecb7834b61a666b0011913b0ec24a8e219023ef

Contents?: true

Size: 1.94 KB

Versions: 25

Compression:

Stored size: 1.94 KB

Contents

/**
Convert 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).

Inspired by [this Stack Overflow answer](https://stackoverflow.com/a/50375286/2172153).

@example
```
import type {UnionToIntersection} from 'type-fest';

type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};

type Intersection = UnionToIntersection<Union>;
//=> {the(): void; great(arg: string): void; escape: boolean};
```

A more applicable example which could make its way into your library code follows.

@example
```
import type {UnionToIntersection} from 'type-fest';

class CommandOne {
	commands: {
		a1: () => undefined,
		b1: () => undefined,
	}
}

class CommandTwo {
	commands: {
		a2: (argA: string) => undefined,
		b2: (argB: string) => undefined,
	}
}

const union = [new CommandOne(), new CommandTwo()].map(instance => instance.commands);
type Union = typeof union;
//=> {a1(): void; b1(): void} | {a2(argA: string): void; b2(argB: string): void}

type Intersection = UnionToIntersection<Union>;
//=> {a1(): void; b1(): void; a2(argA: string): void; b2(argB: string): void}
```

@category Type
*/
export type UnionToIntersection<Union> = (
	// `extends unknown` is always going to be the case and is used to convert the
	// `Union` into a [distributive conditional
	// type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
	Union extends unknown
		// The union type is used as the only argument to a function since the union
		// of function arguments is an intersection.
		? (distributedUnion: Union) => void
		// This won't happen.
		: never
		// Infer the `Intersection` type since TypeScript represents the positional
		// arguments of unions of functions as an intersection of the union.
	) extends ((mergedIntersection: infer Intersection) => void)
		? Intersection
		: never;

Version data entries

25 entries across 25 versions & 1 rubygems

Version Path
immosquare-cleaner-0.1.52 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.51 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.50 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.49 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.48 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.47 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.46 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.45 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.44 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.43 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.42 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.41 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.40 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.39 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.38 node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.32 node_modules/boxen/node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.31 node_modules/boxen/node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.30 node_modules/boxen/node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.29 node_modules/boxen/node_modules/type-fest/source/union-to-intersection.d.ts
immosquare-cleaner-0.1.28 node_modules/boxen/node_modules/type-fest/source/union-to-intersection.d.ts