Sha256: d33782b82eea0ee17b99ca563bd19b38259a3aaf096d306ceaf59cd4422629be

Contents?: true

Size: 1.31 KB

Versions: 89

Compression:

Stored size: 1.31 KB

Contents

// Helper type. Not useful on its own.
type Without<FirstType, SecondType> = {[KeyType in Exclude<keyof FirstType, keyof SecondType>]?: never};

/**
Create a type that has mutually exclusive keys.

This type was inspired by [this comment](https://github.com/Microsoft/TypeScript/issues/14094#issuecomment-373782604).

This type works with a helper type, called `Without`. `Without<FirstType, SecondType>` produces a type that has only keys from `FirstType` which are not present on `SecondType` and sets the value type for these keys to `never`. This helper type is then used in `MergeExclusive` to remove keys from either `FirstType` or `SecondType`.

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

interface ExclusiveVariation1 {
	exclusive1: boolean;
}

interface ExclusiveVariation2 {
	exclusive2: string;
}

type ExclusiveOptions = MergeExclusive<ExclusiveVariation1, ExclusiveVariation2>;

let exclusiveOptions: ExclusiveOptions;

exclusiveOptions = {exclusive1: true};
//=> Works
exclusiveOptions = {exclusive2: 'hi'};
//=> Works
exclusiveOptions = {exclusive1: true, exclusive2: 'hi'};
//=> Error
```
*/
export type MergeExclusive<FirstType, SecondType> =
	(FirstType | SecondType) extends object ?
		(Without<FirstType, SecondType> & SecondType) | (Without<SecondType, FirstType> & FirstType) :
		FirstType | SecondType;

Version data entries

89 entries across 88 versions & 6 rubygems

Version Path
clapton-0.0.11 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.10 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.9 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.8 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.7 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.6 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.5 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.4 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.3 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.2 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
clapton-0.0.1 lib/clapton/javascripts/node_modules/ansi-escapes/node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.32 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.31 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.30 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.29 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.28 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.27 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.26 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.25 node_modules/type-fest/source/merge-exclusive.d.ts
immosquare-cleaner-0.1.24 node_modules/type-fest/source/merge-exclusive.d.ts