Node.jsでモジュールの作成

Node.js

moduleとは、Node.jsでnpmコマンドを使用してインストールすることで利用できる便利な機能が実装済みのモジュールです。今回はNode.jsのモジュールを作成する方法を解説します。

モジュールの作り方

Node.js では CommonJS (CJS) フォーマットが使われ、モジュールとその依存ファイルの定義には require と exports や module.exports を使います。

exports.メソッド名 = function (変数) {
  return 処理
};

使用例:

comm.jsに以下のコードを書く

exports.f1 = (msg) => {
    console.log(msg);
};
main.jsに以下のコードを書いて、実行する。
 
const fu = require(‘./comm.js’);
fu.f1(‘test’);

testを出力される。

requireについて

require はモジュールやファイルをインポートする関数です。
引数にはモジュール(ファイル)のパスや node_module ディレクトリにあるモジュールの名前、またはビルトインモジュールの名前を指定します。拡張子は省略可能です。

requireの引数はモジュール名のみを指定した場合は、最初にビルトインモジュールが検索され、その後 module.paths に記載されているディレクトリが検索されます。

ビルトインモジュールは以下のコマンドで確認できます。
node e “console.log(require(‘module’).builtinModules);”

module.pathsのディレクトリを確認するコマンド
node
e “console.log(module.paths);”

module.exportsとexportsについて

モジュールを他のプログラムで使用できるようにするには exports や module.exports を使います。
exports は module.exports のショートカットのようなもので、初期状態では exports は module.exports への参照です。

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