node package manager


Starling Javascript SDK

npm version


The documentation for our SDK can be found here.


$ npm install --save starling-developer-sdk


const Starling = require('starling-developer-sdk');
// or 
import Starling from 'starling-developer-sk'
const client = new Starling({
    accessToken: '<oauth access token>'
    .then(({data}) =>  console.log(data))
    .catch(err => console.log(err));

Developing the SDK

Install dependencies as follows

$ npm install --save

The following scripts are at your disposal:

$ npm run <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 here for more info on Jekyll and Github Pages)