1.4.6 • Published 9 years ago
stackable v1.4.6
Stackable Javascript Library
This is the Official Stackable API Javascript library for getting data from stacks.
Available and Support in both Browser and NodeJs.
Working examples are found in examples directory!
Install
You can get it on npm
npm install stackable --saveOr bower, too.
bower install get-stackable --saveInclude Stackable file in your project
In browser
<script src="dist/stackable-bower.min.js"></script>browser requires jQuery
In Node
var Stackable = require('stackable');Usage
Make sure to create an account at http://www.stackable.space and setup your Stack and Containers.
To initialize
var stackable = new Stackable('YOUR-STACK-PUBLIC-KEY-HERE');To list all containers
stackable.getContainers(function (error, result) {
console.log(error, result);
});To get single containers
stackable.getContainer('CONTAINER-ID-HERE', function (error, result) {
console.log(error, result);
});To get all items within single container
stackable.getContainerItems('CONTAINER-ID-HERE', function (error, result) {
console.log(error, result);
});To get all items within stack
stackable.getAllItems(function (error, result) {
console.log(error, result);
});To get single item
stackable.getItem('ITEM-ID-HERE', function (error, result) {
console.log(error, result);
});To create new item
- First initialize, using PRIVATE KEY, (MAKE SURE YOU KEEP THIS KEY SAFE! MOSTLY ON SERVER SIDE)
var stackable = new Stackable('YOUR-STACK-PRIVATE-KEY-HERE');var dataToPost = {
name: 'John Doe',
age: 29
};
stackable.createItem('CONTAINER-ID-HERE', dataToPost, function (error, result) {
console.log(error, result);
});To update an item
var dataToUpdate = {
name: 'John Doe',
age: 29
};
stackable.updateItem('ITEM-ID-HERE', dataToUpdate, function (error, result) {
console.log(error, result);
});To build (development)
Sources files are located in src directory
Run npm install to setup required libraries.
npm installnpm Scripts
npm run build- Lint then build the library
Todo
- Write tests