npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

admina

v1.0.1

Published

Detect root/admin/sudo and execute commands as it if available

Downloads

278

Readme

Detect root/admin/sudo and execute commands as it if available

Install

npm install --save admina

admina is tiny and treeshakable.

Usage

Automatic (depends on your build system)

import * as admina from "admina"

Node

import * as admina from "admina/dist/index.node.mjs"

Node CJS

const admina = require("admina/dist/index.node.cjs")

API

admina supports the following functions:

isAdmin (function)

returns: Promise

hasSudo (function)

Detect if sudo is available

returns: boolean

isRoot (function)

Detect if the process has root privilege on Posix.

returns: boolean

import { isRoot } from "admina"

console.log(isRoot())
//=> false

isSudo (function)

Detect if sudo is available and the user has root privileges

returns: boolean

prependSudo (function)

Prepend sudo to the command if sudo is available

Parameters:

  • command (string)

returns: string

defaultExecOptions (variable: execa.SyncOptions)

Default exec options { stdio: "inherit", shell: true }

execRootSync (function)

Execute a command as root if sudo is available. Otherwise executes the command normally without sudo.

Parameters:

  • program (string) - The program to spawn
  • args (string[]) - The command arguments
  • execOptions (SyncOptions<string>) - The options passed to execa. Defaults to { stdio: "inherit", shell: true }

returns: ExecaSyncReturnValue

execRoot (function)

Asynchronously execute a command as root if sudo is available. Otherwise executes the command normally without sudo.

Parameters:

  • program (string) - The program to spawn
  • args (string[]) - The command arguments
  • execOptions (Options<string>) - The options passed to execa. Defaults to { stdio: "inherit", shell: true }

returns: ExecaChildProcess

isAdminWindows (variable)

Check if the process is running as administrator on Windows.

import { isAdminWindows } from "admina"

console.log(await isAdminWindows())
//=> false

isAdminPosix (variable)

Detect if the process has root privilege on Posix.

import { isAdminPosix } from "admina"

console.log(isAdminPosix())
//=> false

isAdmin (function)

Detect if the code is running as admin/root

On Windows, it checks for admin access, and on Posix, it checks for root access

returns: boolean | Promise

import { isAdmin } from "admina"

console.log(isAdmin())
//=> false

grantUserWriteAccess (function)

Give the user access to the given path (and its sub-directories if a directory). It changes the owner to the SUDO_USER. This allows the user to use the folder without sudo

Parameters:

  • path (string) - The path to give the user access to

returns: Promise

🤝 Contributing

You can sponsor my work here:

https://github.com/sponsors/aminya

Pull requests, issues and feature requests are welcome. See the Contributing guide.