npm-install-checks

Check Node Version

This function checks if the current Node.js version meets the specified version requirements. It throws an error if the requirement is not met, allowing developers to handle version incompatibility gracefully.

const { checkNodeVersion } = require('npm-install-checks');
try {
  checkNodeVersion('>=10.0.0', process.version);
  console.log('Node version is compatible.');
} catch (err) {
  console.error('Incompatible Node version:', err);
}

Check Platform

This function verifies if the user's operating system and CPU architecture match the specified criteria. It is useful for ensuring that a package is installed on compatible platforms, preventing runtime errors due to platform incompatibilities.

const { checkPlatform } = require('npm-install-checks');
try {
  checkPlatform({ os: ['darwin', 'linux'], cpu: ['x64'] });
  console.log('Platform is compatible.');
} catch (err) {
  console.error('Incompatible platform:', err);
}