nthread-js

Nthread JS

Create real thread in Node Js from a lambda, file or external app

Install

npm install --save nthread-js

Usage

const nthread = require('nthread-js')( /* options */ ); // Initialize with option

nthread.ready(async (mthread) => // Waiting of the starting process [Parent in Main Thread]
{
	// create a new thread from lambda [Child in Main Thread]
	let child = await mthread.create(async (thread) => { 
		let params = thread.params;
		thread.send(`Now I'm sending child params : ${JSON.stringify(params)}`);
		let pres = await thread.response();
		console.log('CHILD', pres);
	}, 'testOne', 'testTwo');

	// Listen stdout of child
		child.stdout((data) => {
		console.log('child stdout', data);
	});
	
	// Process main thread
	await child.ready();
	let cres = await child.response();
	console.log('ROOT', cres);
	child.send(`Now I'm sending a message to my child`);

	setTimeout(() => { console.log('Exit system'),mthread.exit() }, 3000);

}).catch(err => console.log(err));

More examples

Options from Main Thread

Name	Type	Description
tmpFolder = 'generated'	String	Name of folder who's all temporary files is saved
protocol = 'http://'	String	Protocol
enableSocket = true	Boolean	If enable socket is false so only connect function is available in parent
port = random	Number	Port

Functions from Parent in Main Thread

Name	Type	Description
ip	String	Get public ip
localIp	String	Get local ip
port	String	Get port
address	String	Get public uri
localAddress	String	Get local uri
connect(string: uri, any: param1, ...) : Promise	Function: Promise	Create a new connection to an external app
create(function: callback, any: param1, ...) : Promise	Function: Promise	Create a new thread from the callback
load(string: filePath, any: param1, ...) : Promise	Function: Promise	Create a new thread from the file
connection(function: callback) : Promise	Function: Promise	Event called for each new external connection
exit(number: code = 0)	Function	Close all thread and all connection

Functions from Children in Main Thread

Name	Type	Description
guid	String	Get guid of child
params	String	Recover your initial parameters set from child thread
send(any: data)	Function	Send data to the child thread
response(function: callback) : Promise	Function: Promise	Event called for each response from child thread
ready(function: callback) : Promise	Function: Promise	Event called when the child has finished to initialised
stdout(function: callback) : Promise	Function: Promise	Event called when the child thread write in process (ex: console.log)
stderr(function: callback) : Promise	Function: Promise	Event called when the child thread have an error in process (ex: console.error)
exit(function: callback) : Promise	Function: Promise	Event called when the child thread process has exit
disconnect()	Function	Close child connection

Functions in Children Thread

Name	Type	Description
params	Array	Recover your initial parameters sent from main thread
send(any: data)	Function	Send data to the main thread
response(function: callback) : Promise	Function: Promise	Wait response from the main thread