nimbu-js-sdk

Javascript SDK for nimbu.io

Usage no npm install needed!

<script type="module">
  import nimbuJsSdk from 'https://cdn.skypack.dev/nimbu-js-sdk';
</script>

README

Nimbu JS SDK

The SDK for building Javascript apps on top of Nimbu

Development

  1. Run yarn install
  2. Start the webpack dev server with yarn run start
  3. Visit http://localhost:8080/ (will open automatically)
  4. Play around in the console

Releasing

  1. Run yarn run build

The files for distribution are placed in dist

Version 0.5.2

The build system has switched to webpack for version 1.0.0. A copy of the last release before that (0.5.2) is available in the build directory.

Breaking changes

v1.0.0+ is not compatible with versions < 1.0.0. This sections lists the breaking changes to the public API.

Reduced public API

Modern modularization techniques provide more means to selectively export functions, objects, etc. The old Nimbu object exposed a lot of stuff that was supposed to be private. These are now gone from the public api.

Endpoint

You can no longer assign to Nimbu.endpoint. Pass the endpoint as the second argument to Nimbu.initialize() instead.

Access token

The access token is no longer exposed as Nimbu.accessToken. You have passed it to Nimbu.initialize(), so you know it already :-)

Nimbu.View

Nimbu.View has been removed.

Nimbu.initialize

Nimbu.initialize now returns a Nimbu.Future that resolves when all initialization is finished. You should wait for it to resolve before using the SDK.