unmineable.js
v2.1.1
Published
A JavaScript library for interacting with the UnMineable API and WebSocket
Downloads
11
Maintainers
Readme
UnMineable.js
unmineable.js is a Node.js module that allows you to easily interact with the UnMineable API and WebSocket.
• Promise based
• Performant
• 100% coverage of the UnMineable API and WebSocket
Installation
With GitHub :
• Download the project or clone it
• Go to the unmineable.js folder and do npm install
• Require the client.js
With NPM :
• Download the project
• Do npm install unmineable.js
• Require the library
Documentation
See the API documentation
See the WebSocket documentation
See the changelog
Example usage
Using the library - API
const { Client } = require("unmineable.js");
//OR
import { Client } from "unmineable.js";
const client = new Client();
client.stats().then((data) => {
console.log(data);
});
//OR
const myFunc = async () => {
const data = await client.stats();
console.log(data);
};
myFunc();
The library is async, be sure to use async functions or .then()
Using the library - WebSocket
const { Client } = require("unmineable.js");
//OR
import { Client } from "unmineable.js";
const client = new Client();
client.on("event", (data) => {
console.log(data);
});
client.start("UUID"); //uiid can be found in client.wallet function
List of events available here
Credits
Copyright
See the license