LiveLocalhost Node.js API

LiveLocalhost can be added to a Node.js application and configured using its API. The switches -A or --helpapi show API help from the CLI:

terminal

npx livelocalhost --helpapi

Install LiveLocalhost #

Install LiveLocalhost in your project:

terminal

npm install livelocalhost --save-dev

(--save-dev ensures it’s only available as a development dependency.)

Import the module #

Import the LiveLocalhost module into any JavaScript file (such as index.js):

import { livelocalhost } from 'livelocalhost';

Set configuration options #

The following livelocalhost configuration properties are supported:

// example configuration
livelocalhost.serveport     = 8080;       // HTTP port
livelocalhost.servedir      = './build/'; // directory to serve
livelocalhost.reloadservice = '/reload';  // path to reload service
livelocalhost.hotloadJS     = true;       // hot reload JS
livelocalhost.watchDebounce = 2000;       // debounce time
livelocalhost.accessLog     = true;       // show server logs

(If not set, options fall back to environment variables then defaults.)

Start the server #

Execute the .start() method to start the server:

livelocalhost.start();

Launch your application as normal (node index.js) and open the web server URL in your browser.

Stop your application and the server with Ctrl | Cmd + C.