node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

miniplug

miniplug

Small but complete Promise-based plug.dj API client for Node.js.

Installation - Usage - API - Contributing - License: MIT

Installation

Note: Node v4 or higher is required. Run node -v in your console to check that your Node.js version is up-to-date.

npm install --save miniplug

Usage

const miniplug = require('miniplug')
 
const mp = miniplug({
  email: 'admin@plug.dj',
  password: 'hunter2'
})
 
// Join a room
mp.join('tastycat').then((room) => {
  mp.chat(`Hello ${room.name}! :wave:`)
})
 
// Add an example chat command "!id"
mp.on('chat', (message) => {
  if (/^!id/.test(message.message)) {
    message.reply(`Your user ID is ${message.uid}.`)
  }
})

Full API documentation is available in docs/API.md.

Contributing

Issues/PRs are appreciated!

To build the library, run:

npm run build

The built version will be placed in index.js.

To run tests, do:

npm test

There's not many tests just yet, but it's good to check anyway! This command will also check your code style using Standard.

Changed files will also be tested and linted automatically when you git commit.

License

MIT