Skip to main content

@rtorcato/js-common / node

node

Functions​

nodeVersionCheck()​

nodeVersionCheck(nodeVersion): void

Defined in: node/index.ts:14

Checks if the current Node.js version is less than the specified version. If the version is insufficient, logs a message and exits the process.

Parameters​

nodeVersion​

number

The minimum required Node.js version as a number (e.g., 18).

Returns​

void

Remarks​

This function compares the current Node.js version (process.version) to the required version. If the current version is lower, it prompts the user to update Node.js and terminates the process.

Example​

nodeVersionCheck(18); // Ensures Node.js version is at least 18

getNodeMajorVersion()​

getNodeMajorVersion(): number

Defined in: node/index.ts:30

Returns the current Node.js major version as a number.

Returns​

number

The major version number of the running Node.js process.

Example​

const major = getNodeMajorVersion(); // e.g., 18

isNode()​

isNode(): boolean

Defined in: node/index.ts:42

Checks if the current environment is Node.js.

Returns​

boolean

true if running in Node.js, otherwise false.

Example​

if (isNode()) { ... }

requireOptional()​

requireOptional(moduleName): any

Defined in: node/index.ts:56

Attempts to require a module, returning undefined if the module is not found.

Parameters​

moduleName​

string

The name of the module to require.

Returns​

any

The required module, or undefined if it cannot be loaded.

Example​

const optionalModule = requireOptional('some-module');

getProcessUptime()​

getProcessUptime(): number

Defined in: node/index.ts:73

Returns the process uptime in seconds.

Returns​

number

The number of seconds the current Node.js process has been running.

Example​

const uptime = getProcessUptime();