TypeScript中如何将键值映射安全转换为带必填字段的类型（失败则报错）

核心思路 #

要实现typeCastOrError函数，需要结合运行时校验和TypeScript类型守卫，确保转换后的对象既符合类型定义，又能让TS编译器正确推断类型。核心步骤：

1. 将输入的Map转换为普通对象，简化属性校验逻辑
2. 根据type字段判断目标类型分支（One或Two）
3. 校验对应类型的必填字段是否存在且符合类型要求
4. 校验通过则返回合规对象，否则抛出明确错误信息

完整实现代码 #

type One = {
    'type': 'One';
    a: string;
    x?: string;
}

type Two = {
    'type': 'Two';
    b: string;
    y?: string;
}

// 类型守卫：运行时校验+TS类型推断
function isOne(obj: unknown): obj is One {
    if (typeof obj !== 'object' || obj === null) return false;
    const candidate = obj as One;
    return candidate.type === 'One' && typeof candidate.a === 'string';
}

function isTwo(obj: unknown): obj is Two {
    if (typeof obj !== 'object' || obj === null) return false;
    const candidate = obj as Two;
    return candidate.type === 'Two' && typeof candidate.b === 'string';
}

function typeCastOrError(m: Map<string, string>): One | Two {
    // 将Map转换为普通对象
    const obj = Object.fromEntries(m.entries());

    // 先校验type字段合法性
    if (typeof obj.type !== 'string' || !['One', 'Two'].includes(obj.type)) {
        throw new Error(`无效type字段：${obj.type}，仅支持'One'或'Two'`);
    }

    // 分支校验并返回对应类型
    if (obj.type === 'One') {
        if (!isOne(obj)) {
            throw new Error('转换One类型失败：缺少必填字段a或a不是字符串');
        }
        return obj;
    } else {
        if (!isTwo(obj)) {
            throw new Error('转换Two类型失败：缺少必填字段b或b不是字符串');
        }
        return obj;
    }
}

// 示例使用
const validOneMap = new Map([['type', 'One'], ['a', 'testA'], ['x', 'optionalX']]);
const validTwoMap = new Map([['type', 'Two'], ['b', 'testB']]);
const invalidMap = new Map([['type', 'One'], ['x', 'missingA']]);

try {
    const one = typeCastOrError(validOneMap);
    console.log(one.a); // TS自动推断one为One类型，支持属性提示
    const two = typeCastOrError(validTwoMap);
    console.log(two.b); // TS自动推断two为Two类型，支持属性提示
} catch (e) {
    console.error(e.message);
}

try {
    typeCastOrError(invalidMap);
} catch (e) {
    console.error(e.message); // 输出：转换One类型失败：缺少必填字段a或a不是字符串
}

关键细节说明 #

• 类型守卫的价值：isOne/isTwo函数同时完成运行时结构校验和TS类型推断，确保严格模式下的类型安全，避免类型断言带来的风险。
• 额外键处理：当前实现会保留Map中的额外键，若需要过滤非目标类型的键，可在转换对象时添加过滤逻辑：

  // 仅保留One类型允许的键
  const filteredObj = Object.fromEntries(
    Array.from(m.entries()).filter(([key]) => ['type', 'a', 'x'].includes(key))
  );
  

• 错误信息优化：可以进一步细化错误提示，比如单独检查必填字段是否存在，返回"缺少必填字段a"这类精准信息。

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