https://github.com/lockblock-dev/gminer.js

A JavaScript library for interacting with the GMiner API
https://github.com/lockblock-dev/gminer.js

api crypto gminer miner

Last synced: 6 months ago
JSON representation

A JavaScript library for interacting with the GMiner API

• Host: GitHub
• URL: https://github.com/lockblock-dev/gminer.js
• Owner: LockBlock-dev
• License: mit
• Created: 2021-06-14T13:44:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-01T21:17:18.000Z (almost 3 years ago)
• Last Synced: 2023-03-06T22:43:32.070Z (almost 3 years ago)
• Topics: api, crypto, gminer, miner
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/gminer.js
• Size: 8.79 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# GMiner.js

[![axios](https://img.shields.io/github/package-json/dependency-version/LockBlock-dev/gminer.js/axios)](https://www.npmjs.com/package/axios)

[![GitHub stars](https://img.shields.io/github/stars/LockBlock-dev/gminer.js.svg)](https://github.com/LockBlock-dev/gminer.js/stargazers) ![npm](https://img.shields.io/npm/dm/gminer.js)

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](https://www.npmjs.com/get-npm) and [NodeJS](https://nodejs.org)

With GitHub :

• Download the project or clone it

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

• Require the [index.js](/index.js)

With NPM :

• Download the project

• Do `npm install gminer.js`

• Require the library

## Documentation

See the [API documentation](/API.md).

## Example usage

### Using the library

```js

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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function#syntax) or [.then()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/then#syntax)

## Credits

[GMiner](https://github.com/develsoftware/GMinerRelease)

## Copyright

See the [license](/LICENSE)