引数のキーで、型を条件分岐して指定したい。

Question

下記のようなAPIでデータを取得する関数があります。

const getData = async(param:any) =>{
  return await API.get(url,param).then((res)=>{
    return res;
  })
}

const Param1 = {
  TYPE: 'Order',
  UID: 787459697
  // ... optional
}
type OutputOrder ={
  OrderDetail: {
    OrderNumer: Number,
    Name: String,
    ...
  }
}
const test1:OutputOrder = await getData(Param1)
test1 // -> {OrderDetail :{OrderNumer: 00000, ...}}


const Param2 = {
  TYPE: 'ProductName',
  UID: 'Mikan'
}
type OutputProduct = {
  ProductDetail:{
    ProductName: String,
    ID: Numebr,
    ...
  }
}
const test2:OutputProduct = await getData(Param2)
test2 // -> {ProductDetail :{ProductName: 'Mikan', ...}}

自身が管理するDBから取得する為、返す値の型がわかります。戻り値に型を添えて返し、補完機能を上手く活用したいと考えております。
上記のように、ParamのTYPEによって戻り値がわかる為、TYPEの値によって動的に型を変更するにはどのようにすれば良いでしょうか？

#追記
コード部分を修正しました。

上記のように、ParamのTYPEによって戻り値がわかる為

わかりにくくてすみません。Paramというのは関数に指定した引数の部分です。念の為、Param1という形で定義しました。

Comments

[maisumakun]

> 上記のように、ParamのTYPEによって戻り値がわかる為

上記のコードからその情報が読み取れないのですが、paramの中身と対応するレスポンスについて、もう少し情報をいただけませんでしょうか？

Answer 1

関数のオーバーロードをして引数 param が { type: 'Order' } を満たしている時の戻り値と { type: 'ProductName' } を満たしている時の戻り値それぞれのパターンの型の定義すればやりたいことが実現できると思います

const typeValues = { order: 'Order', product: 'ProductName' } as const;

type InputOrder = {
  TYPE: (typeof typeValues)['order']; UID: number; /* 他に必要なパラメータがあれば適宜追加 */
};
type OutputOrder = {
  OrderDetail: { OrderNumer: number; Name: string; /* ... */ }
};

type InputProduct = {
  TYPE: (typeof typeValues)['product']; UID: string; /* 他に必要なパラメータがあれば適宜追加 */
};
type OutputProduct = {
  ProductDetail: { ProductName: string; ID: number; }
};

// オーバーロード
function getData<T extends InputOrder>(param: T): Promise<OutputOrder>;
function getData<T extends InputProduct>(param: T): Promise<OutputProduct>;
async function getData<T extends InputOrder | InputProduct>(param: T): Promise<OutputOrder | OutputProduct> {
  if (param.TYPE === typeValues.order) {
    // OutputOrder 型を返す処理
    return ....
  }
  // OutputProduct 型を返す処理
  return ....
}

// --------------------------------

async function main () {
  const order = await getData({ TYPE: 'Order', UID: 787459697 }); // 変数 order は OutputOrder 型と推論される
  const product = await getData({ TYPE: 'ProductName', UID: 'Mikan' }); // 変数 product は OutputProduct 型と推論される
}

Comments

[yuki_90453]

ありがとうございます、勉強になりました。