【TypeScript】プリミティブ型に独自型を付けるべきか

投稿日
December 6, 2023
最終更新
December 6, 2023
カテゴリー
tech
タグ
TypeScript雑記

TypeScriptには、Type Aliasesによって独自の名前を付けることができる。

プロダクトの開発の際、プロダクト独自のデータ型に対して、独自に型名を付けるべきなのか気になった。

Type Aliasesを付ける例

type TeamID = number;
type MemberID = number;

type Team = {
  teamID: TeamID;
  memberID: MemberID;
}

①利用者は型の中身が何なのか知らなくても利用できる

②特殊な変数を用意した場合でも、型によってどのような値を入れるべきなのかが分かりやすい（ドキュメントの一部になる）

const nextTeamID: TeamID = 3;

③グローバルな型定義にしていない場合、毎回importしなければならず面倒

import type { TeamID } from 'team';

function getTeamID(): TeamID {
}

プリミティブ型を直接利用する例

type Team = {
  teamID: number;
  memberID: number;
}

①格納されているプリミティブ型が分かりやすい

計算や値を操作する場合に扱いやすい

まとめ

場合によって最適なコードは変わるとは思うが、個人的にはType Aliasesを付けたい派

GitHubX

©2023 すー