Core Operations

Core type operations for modifying property requirements.

PickRequired

Make specified properties required.

import type { PickRequired } from 'uni-types'

interface User {
  name?: string
  age?: number
  email: string
}

type RequiredName = PickRequired<User, 'name'>
// { name: string; age?: number; email: string }

type RequiredMultiple = PickRequired<User, 'name' | 'age'>
// { name: string; age: number; email: string }

See also: PickPartial, OmitRequired

PickPartial

Make specified properties optional.

import type { PickPartial } from 'uni-types'

interface User {
  name: string
  age: number
  email: string
}

type OptionalEmail = PickPartial<User, 'email'>
// { name: string; age: number; email?: string }

See also: PickRequired, OmitPartial

OmitRequired

Make all properties required except specified ones.

import type { OmitRequired } from 'uni-types'

interface User {
  name?: string
  age?: number
  email?: string
}

type RequiredExceptName = OmitRequired<User, 'name'>
// { name?: string; age: number; email: string }

See also: PickRequired, OmitPartial

OmitPartial

Make all properties optional except specified ones.

import type { OmitPartial } from 'uni-types'

interface User {
  name: string
  age: number
  email: string
}

type OptionalExceptEmail = OmitPartial<User, 'email'>
// { name?: string; age?: number; email: string }

See also: PickPartial, OmitRequired