Skip to main content

Neutralino.app

Neutralino.app namespace contains methods related to the current application instance.

app.exit(exitCode)​

Terminates the running application.

Parameters​

  • exitCode Number: Process's exit code. The default value is always 0 (success).
await Neutralino.app.exit(130);

await Neutralino.app.exit();

app.killProcess()​

Kills the application process. If the application becomes unresponsive, you can use this to terminate the process instantly. It is recommended to use the exit() method to close your application properly.

await Neutralino.app.killProcess();

app.restartProcess(options)​

Restarts the current application instance.

Options​

  • args String: Additional command-line arguments that need to be passed to the new application instance's process.
await Neutralino.app.restartProcess();

await Neutralino.app.restartProcess({ args: '--restarted' });

app.getConfig()​

Returns the current application configuration as a JSON object.

Return Object (awaited):​

The current application configuration. Sometimes, this configuration object is not identical to your configuration file because the framework updates the configuration during several situations such as config overriding via CLI arguments and using 0 as the port.

let config = await Neutralino.app.getConfig();
console.log('URL = ', config.url);

app.broadcast(eventName, data)​

Dispatches a new event to all app instances.

Parameters​

  • eventName String: Name of the event.
  • data Object (optional): Additional data for the event.
await Neutralino.app.broadcast('myTestEvent', 'Hello');

await Neutralino.app.broadcast('myTestEvent', {myData: 'Test data'});

await Neutralino.app.broadcast('myTestEvent');

app.readProcessInput(readAll)​

Reads string data from the standard input stream of the application process.

Parameters​

  • readAll Boolean (optional): If this is set to true, the framework will read the entire standard stream. Otherwise, only one line will be returned. The default value for this option is false.
let name = await Neutralino.app.readProcessInput();
console.log(`Hello ${name}`);

Return String (awaited):​

Standard input stream data.

app.writeProcessOutput(data)​

Writes string data to the standard output stream of the application process.

Parameters​

  • data String: Data to be written.
await Neutralino.app.writeProcessOutput('Enter your name: ');
let name = await Neutralino.app.readProcessInput();
await Neutralino.app.writeProcessOutput(`Hello ${name}\n`);

app.writeProcessError(data)​

Writes string data to the standard error stream of the application process.

Parameters​

  • data String: Data to be written.
await Neutralino.app.writeProcessError('This message goes to stderr');