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

autostarter

v1.0.2

Published

Enable autostart for your apps!

Downloads

17

Readme

autostarter

autostarter is a Node.js module that allows you to enable, disable, and check the autostart status of your applications. With autostarter, you can easily manage whether your application starts automatically on system boot.

Static Badge GitHub top language GitHub Repo stars GitHub issues NPM Downloads

Table of Contents

Installation

You can install autostarter using either npm or yarn:

npm

npm install autostarter

yarn

yarn add autostarter

Simple Usage

Here's a basic example demonstrating how to use the autostarter module:

const autostarter = require("autostarter");

// Enable autostart for an application
enableAutostart("myApp", "node myApp.js", "/path/to/app")
  .then(() => console.log("Autostart enabled"))
  .catch((error) => console.error("Failed to enable autostart:", error));

// Disable autostart for an application
disableAutostart("myApp")
  .then(() => console.log("Autostart disabled"))
  .catch((error) => console.error("Failed to disable autostart:", error));

// Check if autostart is enabled
isAutostartEnabled("myApp")
  .then((isEnabled) => {
    if (isEnabled) {
      console.log("Autostart is enabled");
    } else {
      console.log("Autostart is not enabled");
    }
  })
  .catch((error) => console.error("Failed to check autostart:", error));

API Documentation

enableAutostart(appName, command, path)

Enables autostart for the specified application.

  • Parameters:

    • appName (string): The name of the application to be enabled for autostart.
    • command (string): The command to run the application.
    • path (string): The path where the application is located.
  • Returns: Promise<void>: Resolves when autostart is successfully enabled.

disableAutostart(appName)

Disables autostart for the specified application.

  • Parameters:

    • appName (string): The name of the application to be disabled for autostart.
  • Returns: Promise<void>: Resolves when autostart is successfully disabled.

isAutostartEnabled(appName)

Checks if autostart is enabled for the specified application.

  • Parameters:

    • appName (string): The name of the application to check.
  • Returns: Promise<boolean>: Resolves with true if autostart is enabled, false otherwise.

Examples

Enable Autostart

const autostarter = require("autostarter");

autostarter
  .enableAutostart("myApp", "node myApp.js", "/path/to/app")
  .then(() => console.log("Autostart successfully enabled for myApp"))
  .catch((error) => console.error("Error enabling autostart:", error));

Disable Autostart

const autostarter = require("autostarter");

autostarter
  .disableAutostart("myApp")
  .then(() => console.log("Autostart successfully disabled for myApp"))
  .catch((error) => console.error("Error disabling autostart:", error));

Check Autostart Status

const autostarter = require("autostarter");

autostarter
  .isAutostartEnabled("myApp")
  .then((isEnabled) => {
    if (isEnabled) {
      console.log("Autostart is enabled for myApp");
    } else {
      console.log("Autostart is not enabled for myApp");
    }
  })
  .catch((error) => console.error("Error checking autostart status:", error));

Contributing

Contributions are welcome! If you have any suggestions, improvements, or bug reports, please submit an issue or pull request on the GitHub repository.