TypeScript 4.8中如何约束默认值通过验证函数的类型检查？

需求背景 #

我们的库需要在TypeScript 4.8环境下，为开发者提供灵活方式，让他们为终端用户可配置的参数指定验证函数与默认值，示例代码如下：

const a = { validator: (n: number) => n > 10, default: 15 }
const b = { validator: (s: string) => s.length < 5, default: 's' }
const c = { validator: (list: Array<number>) => list.pop() === 1, default: [1, 1] }
const d = { validator: (v: boolean) => v, default: true }

核心需求：当default值传入validator函数返回false时，直接触发TypeScript类型错误。

现有参考实现 #

目前我们已有针对枚举值的校验实现，当default不在指定的可选值数组中时会触发类型错误，等效于possible_values.includes(default)的校验逻辑：

type BaseConfigObject = string | boolean | number | object;

interface ConfigOption<F extends BaseConfigObject, D extends F> {
    possible_values: ReadonlyArray<F>;
    default: D;
}

export function checkedConfigOption<F extends BaseConfigObject, D extends F>(value: ConfigOption<F, D>) {
    return value;
}

开发者使用示例：

const terminal_settings = checkedConfigOption({ possible_values: [true, false, 'auto'], default: 'auto' });
const docked_settings = checkedConfigOption({ possible_values: [true, false, 'docked'], default: false });

核心问题 #

是否存在一种方式，让任意验证函数validator在validator(default)返回false时触发类型错误？

解决方案 #

在TypeScript 4.8中，可以通过条件类型结合类型谓词的方式实现该需求，核心是让TypeScript能识别验证函数的断言逻辑，从而校验默认值的合法性。

实现代码 #

// 定义验证函数类型：接收值T，返回类型谓词断言该值是否合法
type Validator<T> = (value: T) => value is T;

// 配置项基础接口
interface ValidatedConfigOption<T> {
    validator: Validator<T>;
    default: T;
}

// 条件类型：若default不满足validator的断言，则返回never触发类型错误
type ValidateDefault<T, V extends Validator<T>> = 
    V extends (value: T) => value is infer U ? 
        T extends U ? unknown : never : never;

// 校验函数：当default不合法时，类型会被推导为never，触发错误
export function checkedValidatedConfig<T, V extends Validator<T>>(
    config: ValidatedConfigOption<T> & ValidateDefault<T, V>
) {
    return config;
}

使用示例 #

// 合法：15 > 10，校验通过
const a = checkedValidatedConfig({ validator: (n: number): n is number => n > 10, default: 15 });

// 合法：'s'长度1 < 5，校验通过
const b = checkedValidatedConfig({ validator: (s: string): s is string => s.length < 5, default: 's' });

// 合法：[1,1] pop后是1，校验通过
const c = checkedValidatedConfig({ 
    validator: (list: number[]): list is number[] => list.pop() === 1, 
    default: [1, 1] 
});

// 合法：true符合v === true的校验
const d = checkedValidatedConfig({ validator: (v: boolean): v is true => v, default: true });

// 类型错误：5不满足n>10的校验
const e = checkedValidatedConfig({ validator: (n: number): n is number => n > 10, default: 5 });

关键说明 #

• 类型谓词的必要性：验证函数必须返回value is T（或更精确的子类型，如v is true），这样TypeScript才能识别该函数是在断言值的合法性，而非普通布尔返回值。
• 条件类型触发错误：ValidateDefault会检查默认值类型是否属于验证函数断言的合法类型，若不匹配则返回never，使整个配置项类型变为never，触发TypeScript的类型错误提示。
• 局限性：若验证函数包含复杂动态逻辑（如依赖外部变量、运行时计算），TypeScript无法静态推导其断言结果，此时无法触发预期的类型错误。

内容的提问来源于stack exchange，提问作者Jeff Glass