Mana is an small package that provides basic and a dead simple API structure for creating high performance API clients. Take your mana potion and start creating magical API clients which contain the following powers:
- Rolling tokens Supports multiple OAuth tokens which will be switched when rate limits are hit.
- Callback queue Multiple requests calls to the same URL will result in a single call.
- Mirrors When API endpoints become unresponsive, alternate replica's or mirrors API's can be hit instead.
- Back off Build in exponential back off when the API endpoint returns an error or error code.
- Conditional requests Requests with Etags can be cached and result will be reused when a 304 is returned. (Supports async and sync cache engines.)
The module is released through npm.
npm install --save mana
The module assumes a simple pattern. The API end points are listed in a folder
called endpoints. This folder contains JavaScript files which exports
a function:
function Endpoint(api) {
this.api = api;
}
module.exports = EndpointThis function receives a reference to your base API class once it's initialised.
These API endpoints will be introduced on the prototype of your base API in
lowercase. So if you name your file Endpoints it will create an
base.endpoints method for you which access this constructed function. Now the
beauty of this is that these methods support lazy construction. So only when you
access the .endpoints property, it will create a new instance (only once
of course). This way you don't construct pointless API points that might never be
used by your users.
In addition to lowercasing your endpoint and introducing it as constructed property it also exposes the Full class on the base API. This class is Uppercase first, just like all Classes should be in JavaScript.
MIT