❤
npm
Sign UpSign In

mix-it-up-api
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

mix-it-up-api

npm npm bundle size npm NPM

Simplifies calling the devAPI of Mix It Up with TypeScript

This package makes it easier to call the devAPI of Mix It Up such as running a command using TypeScript. It wraps the popular web-request package, extending it with an interface for Mix It Up.

Examples

Get user data by username...

const client = new MixItUpClient();
 
client.users.getUserByName("D4ddy-LiLd4rk")
  .then(user => {
    console.log(user);
  })
  .catch(err => {
    console.log(err);
  });

Send a message to the chat...

const client = new MixItUpClient();
 
client.chat.sendChatMessage("Greetings to the chat!", false)
  .catch(err => {
    console.log(err);
  });

Run the requested command...

const client = new MixItUpClient();
 
client.commands.runCommandByID("YOUR-COMMAND-ID")
  .catch(err => {
    console.log(err);
  });

Getting Started

Make sure you're running Node v13 and TypeScript 3.7 or higher...

$ node -v
v13.11.0
$ npm install -g typescript tsd
$ tsc -v
Version 3.7.5

Install the mix-it-up-api package and the typings definitions for Node.js...

$ npm install mix-it-up-api
$ tsd install node

Write some code...

import * as MixItUpClient from "mix-it-up-api";
 
const client = new MixItUpClient();
 
client.users.getUserByName("D4ddy-LiLd4rk")
  .then(user => {
    console.log(user);
  })
  .catch(err => {
    console.log(err);
  });

Save the above to a file (index.ts), build and run it!

$ tsc index.ts typings/node/node.d.ts --target es6 --module commonjs
$ node index.js
<!doctype html><html ...

To use the sample with your own account, do the following steps:

  • Head over to Streamloots: https://mixitupapp.com/#download

  • Install Mix it Up

  • Log in with your Mixer Account

  • Go to Services

    Services

  • Open the Developer API Panel and hit that "Enable" Button.

    Enable devAPI

  • Call the devAPI from your code!

Special Thanks to SaviorXTanren for his work on the Chatbot and his Documentation of this devAPI over on GitHub.

Readme

Keywords

Package Sidebar

Install

npm i mix-it-up-api

Repository

github.com/D4ddy-LiLd4rk/mix-it-up-api

Homepage

github.com/D4ddy-LiLd4rk/mix-it-up-api#readme

Weekly Downloads

1

Version

1.0.1

License

MIT

Unpacked Size

34.7 kB

Total Files

37

Last publish

Collaborators

  • d4ddy-lild4rk
Try on RunKit
Report malware