1.1.0 • Published 2 years ago

startup-manager v1.1.0

Weekly downloads
-
License
GPL-2.0
Repository
github
Last release
2 years ago

versionweekly_downloadsdownloadsissueslicense

startup-manager

Startup Manager

An easy way to manage startup apps in NodeJS.


Changelog (v1.1.0)

• Fix Disable function not working \ • Improve performance \ • Return proper ResultObject \ • And more bug fixes!


Installation

npm i startup-manager

Usage

This library is ONLY compatible with node version 14 and above! Only supports Windows at the moment

First, you must import the library using the following code:

const StartupManager = require('startup-manager');
// or `import * as StartupManager from 'startup-manager';` for ESM users

\ You can use the following functions with this library, more usage info available in the parameters section

const StartupManager = require('startup-manager');
// or `import * as StartupManager from 'startup-manager';` for ESM users

// Creates the startup key
console.log(StartupManager.Create('SomeAppName', 'C:\\Path\\To\\App\\app.exe', ['--SomeArgument']));

// Returns the status as an object
console.log(StartupManager.Status('SomeAppName'));

// Disables the startup key
console.log(StartupManager.Disable('SomeAppName'));

// Should return { exists: true, status: 'DISABLED' }
console.log(StartupManager.Status('SomeAppName'));

// Enables the startup key
console.log(StartupManager.Enable('SomeAppName'));

// Should return { exists: true, status: 'ENABLED' }
console.log(StartupManager.Status('SomeAppName'));

// Delete the startup key
console.log(StartupManager.Delete('SomeAppName'));

// Should return { exists: false, status: null } now
console.log(StartupManager.Status('SomeAppName'));

Parameters

Parameters info for all of the functions

FunctionParametersDescriptionReturn value
Createname: string, path: string, args: string[]Creates an enabled startup keyResultObject (object)
Deletename: stringDeletes a startup keyResultObject (object)
Enablename: stringEnables a disabled startup keyResultObject (object)
Disablename: stringDisables a enabled startup keyResultObject (object)
Statusname: stringGets the status of a startup keyStatusObject (object)

Objects

NameFormat
ResultObject{ failed: Boolean, error: null \| Error }
StatusObject{ exists: Boolean, status: 'ENABLED' \| 'DISABLED' \| 'UNKNOWN' \| null }

npm.io

1.1.0

2 years ago

1.0.0

2 years ago