types-kit.pickallornone.md

Home > types-kit > PickAllOrNone

PickAllOrNone type

Create a type that requires all of the given keys or none of the given keys. The remaining keys are kept as is.

Signature:

export type PickAllOrNone<T, K extends Keys<T>> = StrictOmit<T, K> &
  (
    | Required<Pick<T, K>>
    | Partial<{
        [P in keyof T as P extends K ? P : never]: never
      }>
  )

References: Keys, StrictOmit

Example

    interface Responder {
      text?: () => string;
      json?: () => string;
      secure?: boolean;
    };

    const responder1: RequireAllOrNone<Responder, 'text' | 'json'> = {
      secure: true
    };
    const responder2: RequireAllOrNone<Responder, 'text' | 'json'> = {
      text: () => '{"message": "hi"}',
      json: () => '{"message": "ok"}',
      secure: true
    };
    const responder2: RequireAllOrNone<Responder, 'text' | 'json'> = {
      json: () => '{"message": "ok"}', // throw error
      secure: true
    };