node-keys-down

1.0.4 • Public • Published

node-keys-down

Check what keys are down with a simple API

installation

npm install node-keys-down

require('node-keys-down').start()

Start detecting keyboard activity. Call this method before the others.

It returns a function that ends detecting keyboard activity.

const keysDown = require('node-keys-down')
const end = keysDown.start()
 
// ... your code
 
end()

require('node-keys-down').isPressed(key)

Returns true if key is pressed. The key code looks like what you might see in event.key.

const keysDown = require('node-keys-down')
keysDown.start()
 
// ...
 
const playerMovingLeft = keysDown.isPressed('ArrowLeft')
const playerRunning = keysDown.isPressed('Shift')
const playerShooting = keysDown.isPressed(' ')
const playerUsing = keyDown.isPressed('e') || keysDown.isPressed('E')

require('node-keys-down').keysPressed()

Returns an array with the names of all keys which are currently pressed.

const keysDown = require('node-keys-down')
keysDown.start()
 
// ...
 
console.log(keysDown.keysPressed())

Readme

Keywords

none

Package Sidebar

Install

npm i node-keys-down

Weekly Downloads

1

Version

1.0.4

License

ISC

Unpacked Size

3.56 kB

Total Files

4

Last publish

Collaborators

  • fabiosantoscode