Node.js 用の自作モジュールの作り方メモ

phi phi on Node.js

Node.js 6連投. 第3弾!

Node.js 用の自作モジュールの作り方についてまとめました.

Node.js におけるモジュールとはクラスや便利関数群のことを言います.

ちょっと簡単な機能が欲しいなって時に自分でモジュールを作って 使い回せば効率良く作業を進めることができます.

簡単に作れるので良かったら参考にしてください.

Module

モジュールの作り方について解説します.

モジュールは exports オブジェクトにメソッドやプロパティを追加して 拡張していくことで作っていきます.

例えば circle モジュールを作る場合は circle.js というファイルを作り, ファイル内で

var PI = Math.PI;

exports.area = function (r) {  
  return PI * r * r;
};

exports.circumference = function (r) {  
  return 2 * PI * r;
};

と書いて実装します.

Usage

上記で作ったモジュールの使い方について解説します.

流れは

  1. モジュールを使うためのファイルを用意する. ここでは run.js とします
  2. require で circle.js モジュールを読み込んで返値を変数に入れます
  3. 返値を入れた変数経由で関数を実行

だけです.

run.js の中身は

var circle = require('./circle.js');  
console.log( '半径 4 の円の面積は ' + circle.area(4));  

って感じになります.

Reference

参考にしたサイトです.

次回は npm で自作モジュールを登録, 公開する方法について解説します.

海外ではすごい勢いでモジュールが作られているみたいですが, まだまだ日本では発展途上です.

ガンガン作って npm で公開して盛り上げていきましょう.