Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

cgminer

tlrobinson36BSD0.1.0

API client for CGMiner Bitcoin miner

bitcoin, cgminer, client, promises, promises/a, promises/a+, q

readme

node-cgminer

Usage

CGMiner command return a Promises/A compatible promise (specifically a Q promise):

var client = new CGMinerClient(HOST, PORT);
client.COMMAND(ARG1, ARG2).then(function(results) {
  console.log(results);
}, function(err) {
  // error handler
});

COMMAND corresponds to one of the commands detailed in CGMiner's API documentation.

TODO

  • Some commands return the raw JSON response object while other return a customized object (devs, etc).
  • Documentation.