is-root

What is is-root?

The is-root npm package is a simple utility that allows you to check if your Node.js process is running as the root user (also known as the superuser). This can be useful for ensuring that certain actions that require elevated privileges are not performed without the appropriate permissions.

What are is-root's main functionalities?

Check if the process is running as root

This feature allows you to determine if the current Node.js process is running with root privileges. The function returns a boolean value: true if the process is root, false otherwise.

const isRoot = require('is-root');

if (isRoot()) {
  console.log('The process is running as root.');
} else {
  console.log('The process is not running as root.');
}

Other packages similar to is-root

sudo-block

The sudo-block package prevents a Node.js program from being run with root privileges. It is similar to is-root in that it deals with root permissions, but instead of just checking, it actively blocks execution when run as root.

is-elevated

The is-elevated package checks if the process is running with elevated privileges (similar to root on Unix systems) on Windows. It serves a similar purpose to is-root but is specifically designed for Windows environments.

README

is-root

Check if the process is running as root user, for example, one started with sudo

Install

$ npm install is-root

Usage

$ sudo node index.js

// index.js
import isRoot from 'is-root';

isRoot();
//=> true

Related

• is-elevated - Check if the process is running with elevated privileges (cross-platform)