Using Node.js Module

Version added 07-Mar-2018| Modified 17-Jun-2019

Using Node.js Core Modules

webOS Open Source Edition (OSE) supports all the Node.js core modules provided by Node.js v8.12.0. For the list of core modules and API details, see Node.js v8.12.0 Manual & Documentation.

webOS OSE releases up to 2019 3rd release support Node.js v6.11.2.

To use Node.js core module, add the module with the top-level identifier to your service as the following code.

var Service = require(‘webos-service’);
var fs = require(‘fs’);

var service = new Service("com.mycom.service.helloworld");

service.register(“writeFile", function(message) {  
  fs.writeFileSync('/media/internal/foobar.txt', 'sample text', "utf8");
    reply: “write complete"

service.register(“readFile", function(message) {  
  fs.readFileSync('/media/internal/foobar.txt', "utf8");
    reply: “read complete"

Using Third-party Modules 

There are many third-party modules for Node.js. To use the third-party modules, follow the next steps.

  1. Use NPM (Node Package Manager) tool in your computer to install the third-party module. The module will be installed in the node_modules directory under the node.js installation directory. 
    See Node Packaged Modules (NPM) for search and installation of these modules.

  2. Create a node_modules directory in your service's root directory. 

  3. Copy modules from the node_modules directory under the node.js directory to node_modules under your service's root directory.

Now, add the third-party module to your service as the following code. The node will find the module from node_modules directory first.  

var md = require('md5');
You cannot use modules including C/C++ add-ons. You must use modules implemented with JavaScript only.


Except as noted, this content is licensed under Creative Commons Attribution 4.0 and sample code is licensed under Apache License 2.0.