RateLimit

RateLimit

RateLimit allows users to query their rate-limit status

Constructor

new RateLimit(auth, apiBaseopt)

construct a RateLimit

Parameters:
Name Type Attributes Description
auth Requestable.auth

the credentials to authenticate to GitHub

apiBase string <optional>

the base Github API URL

Source:

Methods

getRateLimit(cbopt) → {Promise}

Query the current rate limit

Parameters:
Name Type Attributes Description
cb Requestable.callback <optional>

will receive the rate-limit data

Source:
See:
Returns:
  • the promise for the http request
Type
Promise