RequiredKeys

Since 1.0.0

Get keys of required properties.

Signature

type RequiredKeys<T> = {
  [K in keyof T]-?: {} extends Pick<T, K> ? never : K
}[keyof T]

Parameters

Parameter	Description
T	The object type

Description

Extracts the keys of all required (non-optional) properties from an object type.

Examples

Basic Usage

import type { RequiredKeys } from 'uni-types'

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

type Required = RequiredKeys<User>
// 'name' | 'email'

All Optional

interface Optional {
  a?: string
  b?: number
}

type NoRequired = RequiredKeys<Optional> // never

Related

• OptionalKeys - Get optional property keys
• WritableKeys - Get writable property keys
• ReadonlyKeys - Get readonly property keys