Sha256: f0abf96437a6e57b9751a792ba2ebb765729a40d0d573f7f6800b305691b1afb

Contents?: true

Size: 1.03 KB

Versions: 25

Compression:

Stored size: 1.03 KB

Contents

import type {Except} from './except';
import type {ConditionalKeys} from './conditional-keys';

/**
Exclude keys from a shape that matches the given `Condition`.

This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.

@example
```
import type {Primitive, ConditionalExcept} from 'type-fest';

class Awesome {
	name: string;
	successes: number;
	failures: bigint;

	run() {}
}

type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
//=> {run: () => void}
```

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

interface Example {
	a: string;
	b: string | number;
	c: () => void;
	d: {};
}

type NonStringKeysOnly = ConditionalExcept<Example, string>;
//=> {b: string | number; c: () => void; d: {}}
```

@category Object
*/
export type ConditionalExcept<Base, Condition> = Except<
	Base,
	ConditionalKeys<Base, Condition>
>;

Version data entries

25 entries across 25 versions & 1 rubygems

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