Stratumn SDK for Javascript
Installation
Browser
<!-- Polyfill for browser compatibility --><!-- Actual Stratumn SDK -->
If you want a specific version, include https://libs.stratumn.com/stratumn-sdk-{version}.min.js
instead (for instance https://libs.stratumn.com/stratumn-sdk-0.4.1.min.js
).
Node.js
$ npm install stratumn-sdk
var StratumnSDK = ;
Quickstart
StratumnSDK ;
Reference
StratumnSDK#getApplication(appName)
Returns a promise that resolves with an application.
StratumnSDK ;
Application#createMap(...args)
Returns a promise that resolves with a new map.
StratumnSDK ;
Application#getLink(hash)
Returns a promise that resolves with an existing link.
StratumnSDK ;
Application#getMap(mapId, tags)
Returns a promise that resolves with the meta data of the links in a map, optionally filters by tags.
StratumnSDK ;
Application#getBranches(linkHash, tags)
Returns a promise that resolves with the meta data of the links whose previous hashes are the given hash, optionally filters by tags.
StratumnSDK ;
Application#getMapIds()
Returns a promise that resolves with all the map ids in this application.
StratumnSDK ;
Link#getPrev()
Returns a promise that resolves with the previous link of a link.
StratumnSDK ;
Link#load()
Returns a promise that resolves with the full link. Can be useful when you only have the meta data of links.
StratumnSDK ;
Link#getBranches(tags)
Returns a promise that resolves with the meta data of the links whose previous hashes are the hash of the link, optionally filters by tags.
StratumnSDK ;
Link#:transitionFunction(...args)
Executes a transition function and returns a promise that resolves with a new link.
StratumnSDK ;
Development
Install dependencies:
$ npm install
Build:
$ npm run build:all
Test:
$ npm test
Test coverage:
$ npm run test:cov
$ open coverage/lcov-report/index.html
Lint:
$ npm run lint
Lint and test:
$ npm run check
Bump version:
$ npm version major|minor|patch
Publish:
$ npm publish