To trigger a key, simply require the module and directly call it with the name of the key to be triggered. See List of Special Key Names for a list of currently supported keys.

Simple usage

specialkey = require('specialkey-emulator');

specialkey('NX_KEYTYPE_ILLUMINATION_DOWN')

Callback usage

specialkey = require('specialkey-emulator');

specialkey('NX_KEYTYPE_ILLUMINATION_DOWN', function (err, result) {
    if (err) {
        return console.log('Error', err);
    }
    console.log('Key triggered', result);
})

API

Overview

This module directly exports itself as a function:

require('specialkey-emulator')(keyName, callback)

Parameters

It takes the following parameters:

keyName (String) - Name of the key to be triggered. See List of Special Key Names.
callback (Function) - Called after trying to trigger the special key.
- error (Error) - Error
- result (Number) - Internal code of the key which was called.

List of Special Key Names

OSX

Reference: Darwin Keyboard Events @ opensource.apple.com
Names
- NX_KEYTYPE_SOUND_UP
- NX_KEYTYPE_SOUND_DOWN
- NX_KEYTYPE_BRIGHTNESS_UP
- NX_KEYTYPE_BRIGHTNESS_DOWN
- NX_KEYTYPE_CAPS_LOCK
- NX_KEYTYPE_HELP
- NX_KEYTYPE_POWER_KEY
- NX_KEYTYPE_MUTE
- NX_KEYTYPE_UP_ARROW_KEY
- NX_KEYTYPE_DOWN_ARROW_KEY
- NX_KEYTYPE_NUM_LOCK
- NX_KEYTYPE_CONTRAST_UP
- NX_KEYTYPE_CONTRAST_DOWN
- NX_KEYTYPE_LAUNCH_PANEL
- NX_KEYTYPE_EJECT
- NX_KEYTYPE_VIDMIRROR
- NX_KEYTYPE_PLAY
- NX_KEYTYPE_NEXT
- NX_KEYTYPE_PREVIOUS
- NX_KEYTYPE_FAST
- NX_KEYTYPE_REWIND
- NX_KEYTYPE_ILLUMINATION_UP
- NX_KEYTYPE_ILLUMINATION_DOWN
- NX_KEYTYPE_ILLUMINATION_TOGGLE

Author

sidneys.github.io 2018

License

MIT

Keywords

FAQs

What is specialkey-emulator-cli?

Is specialkey-emulator-cli well maintained?

Package last updated on 28 Jul 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

specialkey-emulator-cli