🆗
もう少し楽にBranded Typeを使えるようにしたい
もう少し楽にBranded Typeを使えるようにしたい
と感じたので「Branded Type」を簡単に生成できるツールを作成しました。
安直な理由ですが、「型定義ツール」のように、Branded Typeも気軽に作れる環境があればもっと広まるんじゃないかな？と思ったからです。
特に最近の開発で、似たような名前のIDやデータを扱う機会が多く、以下のような問題がありました。
- 同じ型（string, numberなど）でも意味が異なるデータが混在してしまう
- 間違った型を使う可能性がある
たとえば以下のようなケースです。
同じ型でも異なる意味のデータ
- 投稿ID: 投稿を一意に識別するUUID（型は
string） - ユーザーID: 各ユーザーに割り当てられた8桁の文字列（型は
string）
どちらも型はstringですが、全く異なる用途で使います。この問題を少しでも軽減するためにBranded Typeが役立ちます。
使い方
このツールでは、以下のようにCSV形式やタブ形式で項目を入力するだけで簡単にBranded Typesを生成できます。
CSV形式以外でタブ形式でも生成できるようにしたのは、現職で開発をするときにConfluenceやExcelなどドキュメントを元にコードを書いているので、ドキュメントからコピペで生成できると便利だと思ったからです。
もし他にも良い生成形式があればイシューにて起票してください！
生成するソースコードは、私が見た中で一番シンプルかつ分かりやすいと感じたこちらの記事を参考に生成しています。
生成例
どちらの値でも同じ結果を出力できます。
タブ形式
postId number
userId string
body string
CSV形式
postId,number
userId,string
body,string
生成されるコード
const postIdBrand = Symbol();
export type PostId = number & { [postIdBrand]: unknown };
export function createPostId(p: number): PostId {
return p as PostId;
}
const userIdBrand = Symbol();
export type UserId = string & { [userIdBrand]: unknown };
export function createUserId(p: string): UserId {
return p as UserId;
}
const bodyBrand = Symbol();
export type Body = string & { [bodyBrand]: unknown };
export function createBody(p: string): Body {
return p as Body;
}
ソースコード
このツールのソースコードはGitHubで公開しています。
Discussion