developer-sdk-js
Installation
$ yarn add starlingbank-developer-sdk-js
Usage
const Starling = require('starling-developer-sdk');
const client = new Starling({
accessToken: '<oauth access token>'
});
client.getBalance()
.then(({data}) => console.log(data))
.catch(err => console.log(err));
Developing the SDK
Install dependencies as follows
$ yarn install
The following scripts are at your disposal:
yarn <script> |
Description |
---|---|
clean |
Removes the compiled code. |
build |
Compiles the application to disk (dist/ by default). |
lint |
Lint all .js files. |
test |
Runs unit tests with mocha. |
test-verbose |
Runs unit tests with debug logging. |
Developing the docs locally
You can develop the docs locally by running a jekyll server. Checkout the gh-pages branch and execute
$ bundle install
$ bundle exec jekyll serve
This depends on ruby and bundler (see https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)