関数の返値

返値とは

返値は、その名が示すとおり関数の実行が完了した時に返される値です。返値についてそこまで意識してこなかったかもしれませんが、これまでに何度か返値を見てきているはずです。

以下の見覚えのある例を見てみましょう（このシリーズの過去の記事より）。

const myText = "今日は寒い";
const newString = myText.replace("寒い", "暖かい");
console.log(newString); // "今日は暖かい" と出力
// 文字列の replace() 関数は文字列を受け取り、
// 一方の部分文字列をもう一方の部分文字列に置き換え、
// 置き換えられた新しい文字列を返します。

replace() 関数が myText という文字列の上で実行され、2 つの引数が渡されています。

• 置換される部分文字列 ('寒い')
• 置換する文字列 ('暖かい')

この関数が完了（実行が終了）した時に、関数は置換が行われた新しい文字列を値として返します。上記のコードでは、この返値を変数 newString に代入しています。

replace() 関数についての MDN のリファレンスページには、返値という節があります。関数によって返される値が何か知り把握することはとても重要です。従って、可能な限りこちらも見るようにしてください。

関数によっては何も値を返しません。（この場合、リファレンスページでは返値を void または undefined として記載しています。）たとえば、前の記事で作った displayMessage() 関数では、関数が呼び出されたときに特定の値を返していません。ただ画面のどこかにボックスの表示を作るだけです。

一般的に、返値は、関数が何らかの計算の中間段階である場合に用いられます。最終結果を取得したい場合、関数によって計算される必要がある値がいくつか関与します。関数が値を計算した後、結果を返すことで、変数に格納することができます。そして、この変数を次の段階の計算で使用することができます。

値を返す方法

カスタム関数から値を返すために、必要なことは、 return というキーワードを使うことです。直近の random-canvas-circles.html の例でこれを見たでしょう。draw() 関数は 100 のランダムな円を HTML の <canvas> 内に表示します。

function draw() {
  ctx.clearRect(0, 0, WIDTH, HEIGHT);
  for (let i = 0; i < 100; i++) {
    ctx.beginPath();
    ctx.fillStyle = "rgb(255 0 0 / 50%)";
    ctx.arc(random(WIDTH), random(HEIGHT), random(50), 0, 2 * Math.PI);
    ctx.fill();
  }
}

ループの繰り返しの中で、現在の円の x 座標、y 座標、半径それぞれのランダムな値を生成するために random() 関数に対して 3 回の呼び出しが行われます。random() 関数はひとつの引数（整数）を受け取り、0 からその受け取った数値までの乱数を返します。以下のようになります。

function random(number) {
  return Math.floor(Math.random() * number);
}

次のように書くことも可能です。

function random(number) {
  const result = Math.floor(Math.random() * number);
  return result;
}

しかし最初のものの方がよりコンパクトで、効率よく書けています。

関数が呼び出されるたびに、 Math.floor(Math.random() * number) の計算の結果が返されます。この返値は、関数が呼び出された場所に現れて、コードが続行されます。

したがって、次のものを実行した場合、

ctx.arc(random(WIDTH), random(HEIGHT), random(50), 0, 2 * Math.PI);

3 つの random() がそれぞれ 500、200、35 と値を返した場合、このコードは実際には次のように実行されたことになります。

ctx.arc(500, 200, 35, 0, 2 * Math.PI);

コード上の関数の呼び出しがまず行われ、その返値が関数の呼び出しの代わりとなり、その後にコードそのものが実行されます。

関数の返値の実装

返値のある関数をいくつか書いてみましょう。

1. function-library.html ファイルを GitHub からローカル環境にコピーしましょう。これは単純な HTML ページで、テキスト <input> フィールドと段落が格納されています。また、 <script> 要素もあり、 2 つの変数に両方の HTML 要素への参照が格納されています。このページでは、テキストボックスに数値を入力すると、下にそれに関連のある異なる数値が表示されます。

2. いくつかの有益な関数を <script> 要素の既存の 2 行の下に追加しましょう。

   js

   function squared(num) {
     return num * num;
   }
   
   function cubed(num) {
     return num * num * num;
   }
   
   function factorial(num) {
     if (num < 0) return undefined;
     if (num === 0) return 1;
     let x = num - 1;
     while (x > 1) {
       num *= x;
       x--;
     }
     return num;
   }
   

   squared() 関数と cubed() 関数は大変わかりやすいでしょう。引数として渡された値の 2 乗や 3 乗を返しています。 factorial() 関数は渡された数の階乗を返します。

3. テキストフィールドに入力された数値を出力する処理を追加していきます。イベントハンドラーを既存の関数の下に記述しましょう。

   js

   input.addEventListener("change", () => {
     const num = parseFloat(input.value);
     if (isNaN(num)) {
       para.textContent = "数値を入力してください。";
     } else {
       para.textContent = `${num} の二乗は ${squared(num)} です。`;
       para.textContent += `${num} の三乗は ${cubed(num)} です。`;
       para.textContent += `${num} の階乗は ${factorial(num)} です。`;
     }
   });
   

4. コードを保存して、それをブラウザーで読み込み、試してみましょう。

上記のステップ 3 の addEventListener() 関数について説明します。

• change イベントリスナーを追加することで、この関数はテキスト入力欄で change イベントが発行されるたびに実行されます。つまり、新しい値が input に入力されたときと、確定された時です（値を入力し、 Tab か Return を押して入力からフォーカスを外したときなど）。この無名関数が実行されると、 input に入力された値が num 定数に代入されます。
• if 文で、数値でないものが入力された場合にエラーメッセージを表示します。この条件は、式 isNaN(num) が true を返すかどうかチェックします。 isNaN() 関数は num が数値でないかどうかを検査します。数値でない場合は true を返し、そうであれば false を返します。
• もしこの条件が false を返した場合、num の値は数値であり、関数が段落要素内に数値の二乗、三乗、階乗の値を示す文を表示します。この文では squared()、cubed()、factorial() の各関数を呼び出し、必要な値を計算します。

自分だけの関数を追加してみよう！

この時点で、独自の関数をいくつか書き出してライブラリーに追加してみましょう。ある数値の平方根や立方根を求める関数どうですか？また、特定の半径を持つ円の円周を求める関数はどうでしょうか？

関数に関するいくつかのヒントを示します。

• エラー処理を関数に書く別の例を見てください。一般に、必要な引数が妥当かどうか、省略可能な引数には何らかの既定値が提供されているかどうかを調べるのはよい考えです。こうすることで、プログラムのエラーが発生しにくくなります。
• 関数ライブラリーを作成するという考えについて考えてみましょう。プログラミングのキャリアを重ねるにつれて、同じようなことを何度も繰り返すようになるでしょう。このようなことを行うためのユーティリティ関数のライブラリーを自分自身で作成するのはよい考えです。新しいコードにコピーすることもできますし、 HTML ページに適用することもできます。

まとめ

以上、関数は楽しく、とても便利で、構文や機能についてまだまだ話すことはたくさんありますが、それらはかなり理解しやすいものです。

次回の記事では、これまでの記事で関数について説明した内容について、どれだけ理解し、身についているかを確認するためのテストをいくつかご紹介します。

関連情報

• 関数 — より高度な関数に関連した情報を網羅した詳細なガイド。
• Callback functions in JavaScript — 一般的な JavaScript のパターンは、ある関数を別の関数に引数として渡すことです。それは受け取った関数の中で呼び出されます。これについては、このコースの範疇を少し超えていますが、すぐにでも勉強する価値はあります。

• 前のページ
• Overview: JavaScript による動的スクリプティング
• 次のページ