DeepOmit

Since 1.1.0

Remove properties at nested paths.

Signature

type DeepOmit<T, P extends string> = T extends object
  ? P extends ''
    ? T
    : DeepOmitBySegments<T, PathSegments<T, P>>
  : T

Parameters

Parameter	Description
T	The target object type
P	The path to omit

Description

Removes properties at specified nested paths from an object type.

Examples

Basic Usage

import type { DeepOmit } from 'uni-types'

interface User {
  profile: {
    name: string
    email: string
    settings: {
      theme: string
      lang: string
    }
  }
}

type WithoutSettings = DeepOmit<User, 'profile.settings'>
// { profile: { name: string; email: string } }

Single Property

interface Config {
  database: {
    host: string
    port: number
    password: string
  }
}

type SafeConfig = DeepOmit<Config, 'database.password'>
// { database: { host: string; port: number } }

Related

• DeepPick - Keep only specified paths
• Omit - TypeScript's built-in Omit