deep-omit-ts

DeepOmit<Type, Keys>

Utility type for omitting nested properties from a type. Fully type-safe, has nice autocompletion, and works with arrays.

📦 Installation

NPM

npm install --save-dev deep-omit-ts

Yarn

yarn add --dev deep-omit-ts

⏱️ Quick Start

import { DeepOmit } from 'deep-omit-ts';

type Example = {
  a: string;
  b: {
    c: string;
    d: {
      e: string;
      f: string;
    };
  };
};

type Omitted = DeepOmit<Example, 'a' | 'b.d.e'>;

📖 Documentation

Basic Usage

DeepOmit<Type, Keys> is a utility type that takes two generic parameters:

• Type - The type to omit properties from
• Keys - Keys of the properties to omit

DeepOmit can be used like the built-in Omit utility type:

type Todo = {
  title: string;
  description: string;
  completed: boolean;
  createdAt: number;
}

type TodoPreview = DeepOmit<Todo, "description">;

const todo: TodoPreview = {
  title: "Clean room",
  completed: false,
  createdAt: 1615544252770,
};

A union of keys can be used to omit multiple properties:

type TodoInfo = Omit<Todo, "completed" | "createdAt">;

const todoInfo: TodoInfo = {
  title: "Pick up kids",
  description: "Kindergarten closes at 5pm",
};

Nested Properties

Unlike Omit, DeepOmit can omit nested properties:

import { DeepOmit } from 'deep-omit-ts';

type Example = {
  foo1: string;
  foo2: {
    bar1: string;
    bar2: {
      baz1: string;
      baz2: string;
    };
  };
};

type Omitted = DeepOmit<Example, 'foo2.bar1' | 'foo2.bar2.baz1'>;

const omitted: Omitted = {
  foo1: 'foo1',
  foo2: {
    bar2: {
      baz2: 'baz2',
    },
  },
};

When writing the keys you'll see that the autocompletion works as expected:

Arrays

DeepOmit works with arrays as well:

type Example = Array<{
  foo1: string;
  foo2: Array<{
    bar1: string;
    bar2: string;
  }>;
}>;

type Omitted = DeepOmit<Example, 'foo2.bar2'>

const omitted: Omitted = [
  {
    foo1: 'foo1',
    foo2: [
      {
        bar1: 'bar1',
      }
    ]
  }
];

Ignored Types

An optional third generic parameter can be applied to DeepOmit to ignore the properties of certain types. This is especially helpful if your type contains large classes (like most of JavaScript's built-ins) where you don't want their keys to show up in the autocompletion. It can also help with the type-checker's performance on very large types.

class SomeLargeClass {
  // Imagine a lot of properties and methods here
}

type Example = {
  foo: string;
  bar: SomeLargeClass;
};

type Omitted = DeepOmit<Example, 'bar', SomeLargeClass>;

DeepOmit will automatically ignore checking the props of the following types:

• Function
• Number
• String
• Map<any, any>
• Promise<any>
• Date
• RegExp