Skip to main content

DistributiveOmit

A type that applies Omit to each member of a union type. It uses conditional types to behave like the distributive law.


Interface​

typescript
type DistributiveOmit<T, K extends PropertyKey> = T extends any
  ? Omit<T, K>
  : never;

Type Parameters​

NameConstraintDefaultDescription
T--The union type to distribute over
KPropertyKey-The property key(s) to omit

Usage​

typescript
import { DistributiveOmit } from '@modern-kit/types';

type Union = { a: string } | { b: number }
type Result = DistributiveOmit<Union, 'a'>

// How it works step by step
// 1. Result = DistributiveOmit<Union, 'a'>
// 2. Result = Omit<{ a: string }, 'a'> | Omit<{ b: number }, 'a'>
// 3. Result = {} | { b: number }