npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

miningrigrentals-api-v2

v1.1.2

Published

Node JS Module interface with the Mining Rig Rentals API V2 easily

Downloads

55

Readme

Build Status

Mining Rig Rentals API V2

miningrigrentals-api-v2 is a JavaScript wrapper library over the MiningRigRentals (MRR) API, using es6/7 async functionality. First create a MRR and generate an API key and secret. Then simply download and import the library to start using it. Initialize the MRR class with your api key and secret, and call any method defined in the documentation!

Installation

To install miningrigrentals-api-v2 for use in an application, install the latest version from NPM and save it to your package.json. For this example we're using npm

$ npm install miningrigrentals-api-v2

Getting Started

To get started using the library, first import the MiningRigRentals class from the miningrigrentals-api-v2 module.

import MiningRigRentals from 'miningrigrentals-api-v2'

After you have imported the api, you can go ahead and spawn a new MiningRigRentals Object. You must pass it your MRR api key and secret or else the class will not be able to make the API calls.

const apiKey = {
	key: api_key,
	secret: api_secret
};
let MRR = new MiningRigRentals(api_key)

Using your first method

To make sure the class was initiliazed correctly, we can test authorization by calling:

let test = await MRR.whoami()

This library wraps every function in a es7 async/await wrapper. If instead you wish to deal with promises in a different way, feel free to do:

MRR.whoami().then(success => success).catch(err => err)

We recommend using async/await as it makes the code more terse. await will resolve the promise in a synchronous manner that allows one to expect deterministic behavior.

If test.success === true than you are good to go!

Check out the rest of the documentation to see what else you can do!

Documentation

https://oipwg.github.io/miningrigrentals-api-v2/