Type alias Except<ObjectType, KeysType>

Except<ObjectType, KeysType>: { [ KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType] }

Create a type from an object type without certain keys.

This type is a stricter version of Omit. The Omit type does not restrict the omitted keys to be keys present on the given type, while Except does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.

This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types (microsoft/TypeScript#30825).

Example

import type {Except} from 'type-fest';

type Foo = {
a: number;
b: string;
c: boolean;
};

type FooWithoutA = Except<Foo, 'a' | 'c'>;
//=> {b: string};

Type Parameters

  • ObjectType

  • KeysType extends keyof ObjectType

Generated using TypeDoc