Home > Articles

This chapter is from the book

Creating a Node.js Application

Now you have enough information to jump into a Node.js project and get your feet wet. In this section, you create your own Node Packaged Module and then use that module as a library in a Node.js application.

The code in this exercise is kept to a minimum so that you can see exactly how to create a package, publish it, and then use it again.

Creating a Node.js Packaged Module

To create a Node.js Packaged Module you need to create the functionality in JavaScript, define the package using a package.json file, and then either publish it to the registry or package it for local use.

The following steps take you through the process of building a Node.js Packaged Module using an example called censorify. The censorify module accepts text and then replaces certain words with asterisks:

  1. Create a project folder named .../censorify. This is the root of the package.

  2. Inside that folder, create a file named censortext.js.

  3. Add the code from Listing 3.1 to censortext.js. Most of the code is just basic JavaScript; however, note that lines 18–20 export the functions censor(), addCensoredWord(), and getCensoredWords(). The exports.censor is required for Node.js applications using this module to have access to the censor() function as well as the other two.

    Listing 3.1 censortext.js: Implementing a simple censor function and exporting it for other modules using the package

    01 var censoredWords = ["sad", "bad", "mad"];
    02 var customCensoredWords = [];
    03 function censor(inStr) {
    04   for (idx in censoredWords) {
    05     inStr = inStr.replace(censoredWords[idx], "****");
    06   }
    07   for (idx in customCensoredWords) {
    08     inStr = inStr.replace(customCensoredWords[idx], "****");
    09   }
    10   return inStr;
    11 }
    12 function addCensoredWord(word){
    13   customCensoredWords.push(word);
    14 }
    15 function getCensoredWords(){
    16   return censoredWords.concat(customCensoredWords);
    17 }
    18 exports.censor = censor;
    19 exports.addCensoredWord = addCensoredWord;
    20 exports.getCensoredWords = getCensoredWords;
  4. Once the module code is completed, you need to create a package.json file that is used to generate the Node.js Packaged Module. Create a package.json file in the .../censorify folder. Then add contents similar to Listing 3.2. Specifically, you need to add the name, version, and main directives as a minimum. The main directive needs to be the name of the main JavaScript module that will be loaded, in this case censortext. Note that the .js is not required, Node.js automatically searches for the .js extension.

    Listing 3.2 package.json: Defining the Node.js module

    01 {
    02   "author": "Brendan Dayley",
    03   "name": "censorify",
    04   "version": "0.1.1",
    05   "description": "Censors words out of text",
    06   "main": "censortext",
    07   "dependencies": {},
    08   "engines": {
    09       "node": "*"
    10   }
    11 }
  5. Create a file named README.md in the .../censorify folder. You can put whatever read me instructions you want in this file.

  6. Navigate to the .../censorify folder in a console window and run the npm pack command to build a local package module.

  7. The npm pack command creates a censorify-0.1.1.tgz file in the .../censorify folder. This is your first Node.js Packaged Module.

Publishing a Node.js Packaged Module to the NPM Registry

In the previous section you created a local Node.js Packaged Module using the npm pack command. You can also publish that same module to the NPM repository at http://npmjs.com/.

When modules are published to the NPM registry, they are accessible to everyone using the NPM manager utility discussed earlier. This allows you to distribute your modules and applications to others more easily.

The following steps describe the process of publishing the module to the NPM registry. These steps assume that you have completed steps 1 through 5 from the previous section:

  1. Create a public repository to contain the code for the module. Then push the contents of the .../censorify folder up to that location. The following is an example of a Github repository URL:

  2. Create an account at https://npmjs.org/signup.

  3. Use the npm adduser command from a console prompt to add the user you created to the environment.

  4. Type in the username, password, and email that you used to create the account in step 2.

  5. Modify the package.json file to include the new repository information and any keywords that you want made available in the registry search as shown in lines 7–14 in Listing 3.3.

    Listing 3.3 package.json: Defining the Node.js module that includes the repository and keywords information

    01 {
    02   "author": "Brad Dayley",
    03   "name": "censorify",
    04   "version": "0.1.1",
    05   "description": "Censors words out of text",
    06   "main": "censortext",
    07   "repository": {
    08     "type": "git",
    09     //"url": "Enter your github url"
    10   },
    11   "keywords": [
    12     "censor",
    13     "words"
    14   ],
    15   "dependencies": {},
    16   "engines": {
    17       "node": "*"
    18   }
    19 }
  6. Publish the module using the following command from the .../censor folder in the console:

    npm publish

Once the package has been published you can search for it on the NPM registry and use the npm install command to install it into your environment.

To remove a package from the registry make sure that you have added a user with rights to the module to the environment using npm adduser and then execute the following command:

npm unpublish <project name>

For example, the following command unpublishes the censorify module:

npm unpublish censorify

In some instances you cannot unpublish the module without using the --force option. This option forces the removal and deletion of the module from the registry. For example:

npm unpublish censorify --force

Using a Node.js Packaged Module in a Node.js Application

In the previous sections you learned how to create and publish a Node.js module. This section provides an example of actually using a Node.js module inside your Node.js applications. Node.js makes this simple: All you need to do is install the NPM into your application structure and then use the require() method to load the module.

The require() method accepts either an installed module name or a path to a .js file located on the file system. For example:


The .js filename extension is optional. If it is omitted, Node.js searches for it.

The following steps take you through that process so you can see how easy it is:

  1. Create a project folder named .../readwords.

  2. From a console prompt inside the .../readwords folder, use the following command to install the censorify module from the censorify-0.1.1.tgz package you created earlier:

    npm install .../censorify/censorify-0.1.1.tgz
  3. Or if you have published the censorify module, you can use the standard command to download and install it from the NPM registry:

    npm install censorify
  4. Verify that a folder named node_modules is created along with a subfolder named censorify.

  5. Create a file named .../readwords/readwords.js.

  6. Add the contents shown in Listing 3.4 to the readwords.js file. Notice that a require() call loads the censorify module and assigns it to the variable censor. Then the censor variable can be used to invoke the getCensoredWords(), addCensoredWords(), and censor() functions from the censorify module.

    Listing 3.4 readwords.js: Loading the censorify module when displaying text

    1 var censor = require("censorify");
    2 console.log(censor.getCensoredWords());
    3 console.log(censor.censor("Some very sad, bad and mad text."));
    4 censor.addCensoredWord("gloomy");
    5 console.log(censor.getCensoredWords());
    6 console.log(censor.censor("A very gloomy day."));
  7. Run the readwords.js application using the node readwords.js command and view the output shown in the following code block. Notice that the censored words are replaced with **** and that the new censored word gloomy is added to the censorify module instance censor.

    C:\nodeCode\ch03\readwords>node readwords
    [ 'sad', 'bad', 'mad' ]
    Some very *****, ***** and ***** text.
    [ 'sad', 'bad', 'mad', 'gloomy' ]
    A very *** day.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020