unmineable.js

2.1.1 • Public • Published

UnMineable.js

axios socket.io-client

GitHub stars npm

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

• Download NPM and NodeJS

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

UnMineable

Copyright

See the license

Package Sidebar

Install

npm i unmineable.js

Weekly Downloads

0

Version

2.1.1

License

MIT

Unpacked Size

31.2 kB

Total Files

11

Last publish

Collaborators

  • lockblock-dev