Code Monkey home page Code Monkey logo

electron-shutdown-command's Introduction

Electron Shutdown Command

Quickly shutdown, reboot, log off, halt, restarts, etc. your computer using the native shutdown command easily from an electron app. Cross platform (Windows; macOS and Linux)

ATTENTION macOS and Linux Users:

You need to run the app as sudo/root to allow to run the shutdown command!

Key Features

  • Secure and lightweight: Uses only node/electron native modules

  • Written in TypeScript

  • Well documented and easy to use

Installation

npm install --save electron-shutdown-command

or

yarn add electron-shutdown-command

Usage

const shutdown = require('electron-shutdown-command');

shutdown.shutdown(); // simple system shutdown with default options

or

import * as shutdown from 'electron-shutdown-command';

shutdown.shutdown(); // simple system shutdown with default options

or

/* shutdown after 60 seconds, force all windows to close (Microsoft Windows only),
 * run as sudo (macOS and Linux only), debug command to console
 * (not execute it) and quit app after the command execution
 */
shutdown.shutdown({
  force: true,
  timerseconds: 60,
  sudo: true,
  debug: true,
  quitapp: true
})

or

// Warning: Microsoft Windows only
shutdown.logoff();

Methods

shutdown([options])

shutdown / power-off your machine

reboot([options])

Reboot / restarts your machine

logoff([options])

Ends current session Windows only

sleep([options])

Enters sleep mode macOS only

hibernate([options])

Hibernate Windows only

abort([options])

Aborts or cancels a pending shutdown (this does not apply to "shutdown now", which does not wait before shutting down) Windows and Linux only

Options

Property Type Default Description
force boolean false Forces running applications to close Windows only
sudo boolean false Run command as sudo macOS and Linux
debug boolean false Shows shutdown command on console for debugging purposes NOTE: It does not run it
quitapp boolean false Quits your app after the shutdown command
timerseconds number 0 Sets the timer (value in seconds). NOTES: in macOS the minimum is 1 minute. The logoff, sleep and hibernate option cannot be scheduled, they are executed immediately

Motivation and history

I quickly wrote this library because I need to add a shutdown option to an Electron Windows App. This is a very simple library that justs executes the shutdown command on different OS. Warning: I didn't have enough time to fully test this module on macOS and Linux. If there is enough interest in some specific platform I can try to improve this module (I currently use this module on Windows 10).

Contribution

Please send pull requests improving the usage and fixing bugs, improving documentation and providing better examples, or providing some tests, because these things are important.

Learn More

Shutdown command

License

  • Licensed under MIT

  • Copyright (c) 2017-2020 [Samuel Carreira]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.