を勉強する④ - npmモジュールを使う


はじめに

前回はJavascriptファイル間の連携についてまとめました。
今回はnpmモジュールの使い方を記事にします

教材

Udemy
The Complete Node.js Developer Course (3rd Edition)
https://www.udemy.com/course/the-complete-nodejs-developer-course-2/

npmモジュールを開始する

ルートディレクトリでnpm initのコマンドを実行することでコンフィギュレーションファイルを作成し、npmモジュールの使用を開始する

ターミナル
npm init

するとpackage.jsonという名前のファイルが作られます。

package.json
{
  "name": "notes-app",
  "version": "1.0.0",
  "description": "",
  "main": "app.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

npmモジュールをダウンロードする

https://www.npmjs.com/ にアクセスして、使用したいパッケージを探します。
今回はvalidatorを使います。validatorとサーチして、ページに飛んだら、右上のインストール用のコードをコピーします。

ルートディレクトリでこちらのコードを実行します。

ターミナル
npm i validator

すると、package-lock.jsonファイルが追加され、さらには、package.json内のdependenciesの中にvalidatorが表示されます。
これで、インストールが完了しました。

Validatorを使う

それでは、validatorを使ってみます。validatorを使いたいjsファイルに変数validatorを定義し、require('validator')を代入します。今回は、app.jsとファイルを名付けました。

app.js
const validator = require('validator')

こちらで、準備は完了です。実際に使ってみます。
仮に[email protected]がEmailとしての要件を満たしているか調べて、結果を出力します。

app.js
const validator = require('validator')
console.log(validator.isEmail('[email protected]'))
ターミナル
node app.js
true

Emailとしての要件を満たしているので、trueが出力されます。
その他のメソッドは、Validatorの使い方は、公式に記載がありますので、その都度参照します。