Skip to content

Latest commit

 

History

History
57 lines (44 loc) · 1.27 KB

README.md

File metadata and controls

57 lines (44 loc) · 1.27 KB

Lockscreen

Lock screen of your pc

Install

$ npm install --save lockscreen

Usage

import lockscreen from 'lockscreen';

// just lock the screen
lockscreen();

// callback, good to catch errors - maybe you need the stdout - so the callback also passes this
lockscreen((err, stdout) => {
  if(err) {
    console.log('there was some error', err);
  }
});

// custom command for custom OS
lockscreen(() => {}, {
  myCoolOS: 'the command which will be executed when "process.platform" is "myCoolOS"'
})

Checkout the Wiki if you want to use lockscreen with ES5

Support

Currently it supports:

Create a new issue if your OS is not supported

Related

michaelzoidl/lockscreen-cli

Contribute

# Clone Repo
$ git clone [email protected]:michaelzoidl/lockscreen.git

# Install dependencies
$ npm install

# Test
$ npm test

# Watch the tests
$ npm test -- -w

License

MIT (c) Michael Zoidl