DeepPick

Since 1.1.0

Keep only properties at specified paths.

Signature

type DeepPick<T, P extends string> = T extends object
  ? P extends ''
    ? T
    : DeepPickBySegments<T, PathSegments<T, P>>
  : T

Parameters

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

Description

Keeps only the properties at specified nested paths, removing all others.

Examples

Basic Usage

import type { DeepPick } from 'uni-types'

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

type JustName = DeepPick<User, 'profile.name'>
// { profile: { name: string } }

Nested Path

interface Config {
  app: {
    name: string
    version: string
  }
  database: {
    host: string
    port: number
  }
}

type AppInfo = DeepPick<Config, 'app.name'>
// { app: { name: string } }

Related

• DeepOmit - Remove specified paths
• Pick - TypeScript's built-in Pick