@dumpstate/mainjs

Main script for nodejs apps.

Install

Install package:

npm install @dumpstate/mainjs --save

Usage

@dumpstate/mainjs is a convenience package to avoid interaction with node:cluster. It allows to declare the entrypoint scripts for the nodejs application, and then either start selected scripts or run all with cluster.fork.

e.g., main.ts script for a web application:

import { main } from "@dumpstate/mainjs"

main({
	entrypoints: {
		webserver: "./webserver",
		worker: "./worker",
	},
})

The application declares two entrypoints, webserver and a worker. The values of the configuration object are paths to actual nodejs scripts, relative to current working directory. The target scripts are expected to export start function of interface () => any.

Once compiled and run:

node dist/main.js

both webserver and worker will run in child processes.

Selected entrypoints can be run by specifying the name:

node dist/main.js webserver

@dumpstate/mainjs optionally depends on pino - if not available console is being used for logging. A concrete instance of logger might be provided via config as well as the basic logger configuration.

CLI Arguments

1. --dist-dir to specify the distribution directory (e.g., dist folder, relative to current working directory).

2. --${entrypoint name}-count to specify number of processes we'd like to run for given entrypoint.

OS Signal Handling

Primary process listens for SIGINT and SIGTERM signals, then propagates signal to child processes.

If one process exits, all other child processes will receive SIGTERM signal and the main process will exit as well. In this case the main process supervisor should ensure to re-start.