RateLimit

RateLimit

RateLimit allows users to query their rate-limit status

Constructor

new RateLimit(auth, apiBaseopt) → {Promise}

construct a RateLimit

Source:
Parameters:
Name Type Attributes Description
auth Requestable.auth

the credentials to authenticate to GitHub

apiBase string <optional>

the base Github API URL

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

Methods

getRateLimit(cbopt) → {Promise}

Query the current rate limit

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

will receive the rate-limit data

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