Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.
/ gminer.js Public archive

A JavaScript library for interacting with the GMiner API

License

Notifications You must be signed in to change notification settings

LockBlock-dev/gminer.js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GMiner.js

axios

GitHub stars npm

gminer.js is a Node.js module that allows you to easily interact with the GMiner API.

• Promise based

• Performant

• 100% coverage of the GMiner API

Installation

• Download NPM and NodeJS

With GitHub :

• Download the project or clone it

• Go to the gminer.js folder and do npm install

• Require the index.js

With NPM :

• Download the project

• Do npm install gminer.js

• Require the library

Documentation

See the API documentation.

Example usage

Using the library

const { Client } = require("gminer.js")

const client = new Client(port) //example : 5555 (must be a number)

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()

Credits

GMiner

Copyright

See the license

About

A JavaScript library for interacting with the GMiner API

Topics

Resources

License

Stars

Watchers

Forks