【入門編】 インラインオブジェクト型の定義 – JavaScript実践ガイド

こんにちは!フロントエンドの現場を長年うろついているチーフアーキテクトの私です。

JavaScriptの勉強をはじめたばかりの頃って、次から次へと新しい用語が出てきて「うわ、もう無理……」って心が折れそうになりますよね。特に「型定義」なんて言葉を聞いた日には、画面をそっと閉じたくなる気持ち、痛いほどよく分かります。大丈夫ですよ、今日ここで一緒に、ゆっくり一つずつ紐解いていきましょう!

今回は、JavaScriptでの開発をちょっぴりスマートにしてくれる「インラインオブジェクト型の定義」というテクニックについてお話しします。

難しそうな名前をしていますが、身近な例えを使えば「なぁんだ、そういうことか!」とすぐに腑に落ちるはずです。肩の力を抜いて、リラックスして読んでいってくださいね。

—

1. そもそも「インラインオブジェクト型」ってなに?

いきなりカタカナの専門用語で殴られてしまいましたね。でも安心してください。まずは身近な例えから入ります。

例えば、あなたがスーパーでお弁当を買うとします。
店員さんが「このお弁当の中身を、わざわざ『本日のお惣菜セットA』という名前で台帳に登録してからレジに通しますね」って言ったら、「いやいや、目の前にあるんだから、そのままバーコードピッとやってよ!」って思いませんか?

JavaScriptの関数で引数(ひきすう:関数に渡すデータのことです)を扱うときも、これと全く同じことが起きます。

わざわざ別の場所で「こういうデータ構造ですよ」と大げさな名前をつけて定義するのではなく、「使うその場所(インライン)で、直接オブジェクトの形を書いちゃう」。これが、インラインオブジェクト型定義の正体です。

TypeScriptなどの型システムが導入された環境や、JSDoc(コメントで型を書く手法)を使ったモダンな開発現場では、この書き方がめちゃくちゃ重宝されています。

—

2. まずはつまずきがちな「これまでの書き方」を振り返ろう

「オブジェクト」って聞くと、なんだか難しそうに聞こえますよね。でも、JavaScriptのオブジェクトは、要するに「ラベルと値のセット(入れ物)」です。

例えば、ユーザーのプロフィール情報を関数に渡すシーンを想像してみましょう。

// プロフィール情報を表示する関数
function showProfile(user) {
console.log(ネーム: ${user.name}, 年齢: ${user.age}歳);
}

// 使うときはこう
const myData = { name: ‘太郎’, age: 25 };
showProfile(myData);

これだけでも動くのですが、大規模なアプリを作っていると、「あれ? `user` って、中にどんなデータが入ってるんだっけ? `name` 以外に `mail` とかもあるんだっけ?」と、コード迷子になってしまいます。

そこで、「ちゃんと型(設計図)を決めよう!」となるわけです。

—

3. インラインで直接「設計図」を書いちゃおう

ここで登場するのが、今回の主役であるインラインでの型定義です。

今回は、現場でもよく使われる「JSDoc(ジェイエスドック)」という、コメントとして型を書く手法を使って見てみましょう。エディタ(VS Codeなど)が強力にサポートしてくれるので、初学者の方にこそ使ってほしいテクニックです。

実際のコードを見てみてください。

/

  • ユーザーのプロフィールを表示する関数
  • @param {Object} user – ユーザー情報
  • @param {string} user.name – ユーザーの名前
  • @param {number} user.age – ユーザーの年齢

/
function showProfile(user) {
console.log(こんにちは、${user.name}さん(${user.age}歳)!);
}

// 実際に使ってみる
showProfile({
name: ‘花子’,
age: 28
});

どうでしょう? 関数の真上のコメント(`@param` の部分)で、引数として受け取るオブジェクトの中身(`name` は文字列、`age` は数値)を直接指定していますよね。

これがインラインオブジェクト型の定義です。わざわざ「UserInfo型」みたいな名前を別で作ってエクスポートしなくても、この関数を使うときに「あ、名前と年齢を渡せばいいんだな」というのがひと目で分かります。

—

4. なぜこの書き方が現場で愛されるのか?

「わざわざコメントで書くの、面倒くさくない?」と思ったそこのあなた。鋭い視点ですね!

実は、この書き方には現場のプロたちが思わずニヤリとしてしまう大きなメリットがあります。

① エディタの補完が効いて、ミスが劇的に減る

VS Codeなどのモダンなエディタを使っていると、このコメントのおかげで、関数に渡すオブジェクトを書くときに「あ、`name` と `age` が必要なんだな」と自動でサジェスト(候補表示)してくれます。
うっかり `naem` とタイポ(誤字)してしまっても、エディタが「それ違いますよ」と優しく教えてくれるんです。これ、デバッグの時間が何時間も削減される魔法のような瞬間ですよ。

② コードがあちこちに散らばらない

小さなデータ構造のために、わざわざ別のファイルを作ったり、複雑な名前を考えたりする必要がありません。「この関数の中でしか使わないデータだから、その場でサクッと定義して完結させちゃおう」という割り切りができるので、頭の中がとってもスッキリします。

—

5. チーフアーキテクトからの優しいアドバイス

最初は、コメントの書き方や「型」という概念に戸惑うこともあるかもしれません。「なんだかルールが多くて窮屈だな」と感じる日もあるでしょう。

でも、安心してください。
エラーが出るのは、あなたのコードが間違っているからではなく、エディタやJavaScriptが「あなたのうっかりミスを未然に防ごうと、一生懸命サポートしてくれているから」なんです。

まずは完璧を目指さず、今回紹介したコードを手元のエディタにコピーして、ちょっと名前を変えたりして遊んでみてください。実際に手を動かしていくうちに、「あ、こういうことね!」とパズルがハマる瞬間が必ずやってきます。

あなたのコーディングライフが、少しでも楽しく、ワクワクするものになりますように。
それでは、次の現場でお会いしましょう!

コメント

タイトルとURLをコピーしました