ignite-settings
v0.0.9
Published
Collect common settings from the Ignite Online API
Downloads
7
Readme
Ignite settings
This is a tiny utility library that will hit our API and retrieve our common settings.
This makes it easier for us to maintain/update all our clients platforms without having to charge hours to go through each on of them and manually run the updates.
Usage
The library is written in ES6 but transpiled with babel for your usage. It relies on the fetch API as well, so remember to polyfill if necessary!
import getToken from 'ignite-settings'
It returns a Promise
which resolves to the settings if successful or an error message otherwise:
getToken()
.then(token => { // do stuff })
.catch(error => { // oh no! });
Building
We use Flow for type checking before the build process.
Ensure you have flow
running when developing.
Once finished you can build with:
yarn run build
or
npm run build
Testing
We use Jest to run our tests. Simply run:
npm run test
The tests will display coverage results too. We require 100% test coverage.
Contributing
Please shoot us an email for support/suggestions!