Category: node.js

This video tutorial illustrates searching, installing, updating and removing the external, free modules.

External Free Node Modules are listed at npmjs.org and is managed by NPM – Node Package Manager.

There are so many amazing modules already written to handle so many sophisticated functionalities, that it becomes easy to use them in our application and build a robust, scalable application quickly.

Command to look at all the external module names and their respective description

1

npm search

It gives a long list of names and descriptions.

To make is look better, you can use GREP(if you’re on Linux or Unix based System)
Search with GREP

1

npm search | grep module_name

npm search followed by pipe symbol, which is followed by any module name.

For Windows users

1

npm search module_name

it gives all the details of available methods, properties and their description.

Installation of Modules

init command

1

npm init

Once you run this command, it prompts you with some optional things, like, name of the project, version, author, licensing etc. Once you’re done with that, it creates package.json file with all the details you provided.

The ‘init’ command in NPM allows us to identify our project and list out any Node Modules it requires.

Now open that package.json file: it looks somewhat like this
package.json file

1
2
3
4
5
6
7
8
9
10
11
12

{
  "name": "app",
  "version": "0.0.0",
  "description": "authentication application",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": "",
  "author": "SATISH B",
  "license": "BSD"
}

You need to open this package.json file using a plain text editor and add your project dependencies i.e., some of the modules you need to install for your project.

In this video tutorial we’re installing 3 external modules:
express
jade
mongoose

package.json file, after editing

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "name": "app",
  "version": "0.0.0",
  "description": "authentication application",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
 "dependencies": { "express": "2.5.8", "jade": "0.26.1", "mongoose": "2.6.5" },
  "repository": "",
  "author": "SATISH B",
  "license": "BSD"
}

Now you’ve specified all the external modules your project depends on.

Now using install command, we need to install these modules.
installation command

1

npm install

Once this command is executed, it looks through the package.json file and installs all the dependency modules one by one.

External Module Install, Update, Remove via NPM: Node.js

What is a module?
A module is a self-contained series of one or more javascript files represented by an object.

Update Command

1

npm update

once you run this command, package.json file is parsed and the dependency modules are checked for any updates, if any, it’ll be updated.
If any module is installed with -g (global scope), i.e., the root installation, then while updating or removing them, it may throw some errors, in such case, use sudo keyword:

Update Command

1

sudo npm update -g

This would solve the problem both for updating and deleting external modules.

remove/delete module command

1

npm prune

To remove the unused modules: open package.json file and remove the module names which you want to remove. Save the package.json file and then run above(npm prune) command. This would safely remove the modules you no more intend to use in your project.

List Global module: using command

1

npm -g ls

This lists all the global modules, it’s path and file structure: as shown below:

Example output

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

C:\node\express_example>npm  -g ls
C:\Users\Satish\AppData\Roaming\npm
└─┬ express@3.4.0
  ├── buffer-crc32@0.2.1
  ├─┬ commander@1.2.0
  │ └── keypress@0.1.0
  ├─┬ connect@2.9.0
  │ ├── bytes@0.2.0
  │ ├─┬ multiparty@2.1.8
  │ │ ├── readable-stream@1.0.17
  │ │ └── stream-counter@0.1.0
  │ ├── pause@0.0.1
  │ ├── qs@0.6.5
  │ └── uid2@0.0.2
  ├── cookie@0.1.0
  ├── cookie-signature@1.0.1
  ├── debug@0.7.2
  ├── fresh@0.2.0
  ├── methods@0.0.1
  ├── mkdirp@0.3.5
  ├── range-parser@0.0.4
  └─┬ send@0.1.4
    └── mime@1.2.11

Removing/Uninstalling Global modules: using command

1

npm -g rm

This removes all the global modules installed.

Clear cache

1

npm cache clear

After modifiying things from command prompt, if it’s still not working, try clearing the cache.

Note:
To install latest version of the module: you’ll need to write * (asterisk or star) in the place of version number inside package.json file.