Welcome!

Microservices Expo Authors: Pat Romanski, Elizabeth White, Liz McMillan, Yeshim Deniz, Zakia Bouachraoui

Related Topics: @DevOpsSummit, Java IoT, Microservices Expo

@DevOpsSummit: Blog Feed Post

Node.js ABCs - L Is for Loading | @DevOpsSummit #DevOps

A great benefit of utilizing a language like Node.js is the wide assortment of 3rd party modules that are at your disposal

One of the great benefits of utilizing a language like Node.js is the wide assortment of 3rd party modules that are at your disposal.  From calculating the validity of credit card numbers, to managing network connections, the Node Package Manager (npm) repository has hundreds of thousands of packages available to you.  This article will explain how you can load modules into your project.

Loading and Referencing a Module
In Node.js, modules are accessed either by their name or the file path on the system.  Non-system modules referenced by name will eventually be mapped into a file system path.

Each module exposes a public interface that can be used after the module is imported with the "require" into the current script.

var mod = require("some_module_name");

LoadingDockEquipment

The previous command will import and return an object that represents the external API exposed by the module.  The value of that object is dependent on the module and can include an object, an array, a function, or any other type of JavaScript object.

Developing and Exporting Modules
For the module developer, you must use the CommonJS Module System to make your modules available to the outside world.  Let's create a sample module “person.js” that exports a Person constructor.

/* File person.js */
function Person(name) {
var _name = name;
function name() {
return _name;
}
}
module.exports = Person;

In the above example, the Person function is defined and then specified with the "module.exports" object that the module will export to other scripts that require this module.

As mentioned above, more complex objects can be exported by adding onto the module.exports object with whatever values you deem fit for your module.

/* file mymodule.js */
function sayHi() { console.log("HI!!!"); }
function sayBye() { console.log("BYE!!!"); }
module.exports.sayHi = sayHi;
module.exports.sayBye = sayBye;

Below is the code to load the module and call the sayHi and sayBye functions.

var mymodule = require("./mymodule");
mymodule.sayHi();
HI!!!
mymodule.sayBye();
BYE!!!

Loading a Module
There are a couple of ways to reference modules depending on their kind.  There are core modules, 3rd party modules, or local modules.

Core Modules
Since core modules are part of the distribution, you need only refer to it by it's name (not the path).  Core modules with name collisions to local modules take precedence.  The following line will load a instance of the core "http" module.

var http = require('http');

File Module
A file module is a one that is defined in a single file on the file system.  The person.js example above is an example of a file module.  When loading a file module, you supply a path (full or relative) to the module file, optionally omitting the .js extension.

var mymodule = require("/home/joe/node/modules/mymodule");
var mymodule = require("./mymodule");

In those examples the loader will look for a file named "mymodule.js" in the specified directory.

Folder Modules
Like a file module, when loading a folder module, you specify the absolute or relative location of the folder.  The Node loader will assume this folder is a package and attempt to look for a package definition file (package.json) in which the name and location of the module file are located.  If no package.json file exists, the Node loader will look for a file named index.js.

Loader search procedure
If the module name is not a path and is not a core module, the loader will attempt to find it inside the special "node_modules" folder.  If the module doesn't exist there, it will continue up the path, folder by folder, looking within node_modules folders on those directories until either finds the module or hits the root of the file system.

Conclusion
That's about all there is to it for exporting and loading a Node.js module.  Creating modules is as easy as writing the module code and specifying what is returned with the module.exports object.  Then a simple call to require("module") is all the client has to write to make use of it.

Read the original blog entry...

More Stories By Joe Pruitt

Joe Pruitt is a Principal Strategic Architect at F5 Networks working with Network and Software Architects to allow them to build network intelligence into their applications.

Microservices Articles
Lori MacVittie is a subject matter expert on emerging technology responsible for outbound evangelism across F5's entire product suite. MacVittie has extensive development and technical architecture experience in both high-tech and enterprise organizations, in addition to network and systems administration expertise. Prior to joining F5, MacVittie was an award-winning technology editor at Network Computing Magazine where she evaluated and tested application-focused technologies including app secu...
Using new techniques of information modeling, indexing, and processing, new cloud-based systems can support cloud-based workloads previously not possible for high-throughput insurance, banking, and case-based applications. In his session at 18th Cloud Expo, John Newton, CTO, Founder and Chairman of Alfresco, described how to scale cloud-based content management repositories to store, manage, and retrieve billions of documents and related information with fast and linear scalability. He addresse...
Adding public cloud resources to an existing application can be a daunting process. The tools that you currently use to manage the software and hardware outside the cloud aren’t always the best tools to efficiently grow into the cloud. All of the major configuration management tools have cloud orchestration plugins that can be leveraged, but there are also cloud-native tools that can dramatically improve the efficiency of managing your application lifecycle. In his session at 18th Cloud Expo, ...
The now mainstream platform changes stemming from the first Internet boom brought many changes but didn’t really change the basic relationship between servers and the applications running on them. In fact, that was sort of the point. In his session at 18th Cloud Expo, Gordon Haff, senior cloud strategy marketing and evangelism manager at Red Hat, will discuss how today’s workloads require a new model and a new platform for development and execution. The platform must handle a wide range of rec...
Containers and Kubernetes allow for code portability across on-premise VMs, bare metal, or multiple cloud provider environments. Yet, despite this portability promise, developers may include configuration and application definitions that constrain or even eliminate application portability. In this session we'll describe best practices for "configuration as code" in a Kubernetes environment. We will demonstrate how a properly constructed containerized app can be deployed to both Amazon and Azure ...
SYS-CON Events announced today that DatacenterDynamics has been named “Media Sponsor” of SYS-CON's 18th International Cloud Expo, which will take place on June 7–9, 2016, at the Javits Center in New York City, NY. DatacenterDynamics is a brand of DCD Group, a global B2B media and publishing company that develops products to help senior professionals in the world's most ICT dependent organizations make risk-based infrastructure and capacity decisions.
Discussions of cloud computing have evolved in recent years from a focus on specific types of cloud, to a world of hybrid cloud, and to a world dominated by the APIs that make today's multi-cloud environments and hybrid clouds possible. In this Power Panel at 17th Cloud Expo, moderated by Conference Chair Roger Strukhoff, panelists addressed the importance of customers being able to use the specific technologies they need, through environments and ecosystems that expose their APIs to make true ...
In his keynote at 19th Cloud Expo, Sheng Liang, co-founder and CEO of Rancher Labs, discussed the technological advances and new business opportunities created by the rapid adoption of containers. With the success of Amazon Web Services (AWS) and various open source technologies used to build private clouds, cloud computing has become an essential component of IT strategy. However, users continue to face challenges in implementing clouds, as older technologies evolve and newer ones like Docker c...
CloudEXPO New York 2018, colocated with DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City and will bring together Cloud Computing, FinTech and Blockchain, Digital Transformation, Big Data, Internet of Things, DevOps, AI, Machine Learning and WebRTC to one location.
DevOpsSummit New York 2018, colocated with CloudEXPO | DXWorldEXPO New York 2018 will be held November 11-13, 2018, in New York City. Digital Transformation (DX) is a major focus with the introduction of DXWorldEXPO within the program. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term.