如何利用可辨识联合推断TypeScript函数的返回类型
解决方案
你当前写的getData返回类型被TS推导为Promise<DataObjectA | DataObjectB>,无法根据传入的source值自动匹配对应的返回类型,所以调用时拿不到精准的类型提示。可以通过下面两种方式实现你要的效果:
方式1:泛型+Extract工具类型(推荐,扩展性强)
直接改造getData为泛型函数,绑定入参类型和返回值类型的关联关系即可,后续新增数据源不需要修改函数定义:
interface DataObjectA { source: "dataObjectA"; data: string; } interface DataObjectB { source: "dataObjectB"; data: number; } type DOTypes = DataObjectA | DataObjectB type DOSources = DOTypes["source"]; // 改造后的函数定义 // Extract<DOTypes, {source: T}> 作用是从DOTypes联合里筛选出source字段为T的类型 async function getData<T extends DOSources>(source: T): Promise<Extract<DOTypes, { source: T }>> { const response = await fetch(`https://some-random-endpoint/`, { method: "GET", headers: { "Content-Type": "application/json", }, }); switch (source) { case "dataObjectA": return (await response.json()) as Extract<DOTypes, { source: T }>; case "dataObjectB": return (await response.json()) as Extract<DOTypes, { source: T }>; } throw new Error(`不支持的数据源: ${source}`); }
调用效果
注意getData是异步函数,调用时需要加await获取实际返回值:
const result = await getData("dataObjectA"); // TS自动推导result为DataObjectA类型,data为string类型 result.data.toLowerCase(); // 完全无报错 const result2 = await getData("dataObjectB"); // TS自动推导result2为DataObjectB类型,data为number类型 result2.data.toFixed(2); // 正常可用
方式2:函数重载
如果不需要频繁新增数据源类型,也可以用函数重载实现,声明更直观:
// 重载声明 async function getData(source: "dataObjectA"): Promise<DataObjectA>; async function getData(source: "dataObjectB"): Promise<DataObjectB>; // 内部实现 async function getData(source: DOSources) { const response = await fetch(`https://some-random-endpoint/`, { method: "GET", headers: { "Content-Type": "application/json", }, }); switch (source) { case "dataObjectA": return await response.json() as DataObjectA; case "dataObjectB": return await response.json() as DataObjectB; } throw new Error(`不支持的数据源: ${source}`); }
这种方式的缺点是后续新增DataObjectC这类类型时,需要手动新增对应的重载声明。
内容的提问来源于stack exchange,提问作者IAmNotANumber
相关产品推荐
相关产品推荐

