SetRequired

把对象中指定的键变为必填，其余保持不变。与把全部变为必填的内置 Required 不同，SetRequired 只改动指定的键。

type Ready = SetRequired<T, K>;

用法

SetRequired<T, K>

当你确认某些可选键一定存在时使用，例如在完成检查之后。

import type { SetRequired } from 'es-toolkit/types';

interface User {
  id: number;
  name: string;
  avatar?: string;
}

// 从这里开始头像一定存在。
type ProfileUser = SetRequired<User, 'avatar'>;
// => { id: number; name: string; avatar: string }

declare function renderProfile(user: ProfileUser): void;

function render(user: User) {
  if (user.avatar != null) {
    renderProfile(user as ProfileUser);
  }
}

即使用在 A | B 这样「多个类型之一」的值上，之后也能用 if 分辨出是哪一个。

type Method = { kind: 'card'; cardNo: string; note?: string } | { kind: 'bank'; accountNo: string; note?: string };

function f(v: SetRequired<Method, 'note'>) {
  if (v.kind === 'card') {
    return v.cardNo; // 收窄到卡片这一侧
  }
  return v.accountNo;
}

类型参数

• T：要转换的对象类型。
• K：要变为必填的键，必须是 T 的键。