flatsheet-api-client
v2.0.0
Published
javascript client for flatsheet
Downloads
4
Readme
flatsheet-api-client
JavaScript/node API client for http://github.com/flatsheet/flatsheet
Todos
Create, update, and destroy methods.
Install
npm install --save flatsheet-api-client
Example usage
var Flatsheet = require('flatsheet-api-client');
var flatsheet = new Flatsheet();
/* list of sheets */
flatsheet.sheets.list(function(err, res){
console.log(err, res)
});
/* specific sheet */
flatsheet.sheets.get(sheetID, function (err, res){
console.log(err, res);
});
API
Create flatsheet object
var Flatsheet = require('flatsheet-api-client');
var flatsheet = new Flatsheet({
host: 'https://app.flatsheet.io',
token: 'YOUR_API_KEY'
});
The host
argument is optional, only use it if you aren't using the hosted version of Flatsheet.
The token
argument is not needed for GET requests, only for PUT, POST, and DELETE requests.
Get list of sheets
flatsheet.sheets.list(function(err, res){
console.log(err, res)
});
Get a specific sheet
flatsheet.sheets.get(sheetID, function (err, res){
console.log(err, res);
});
Create a sheet
/* Set sheet properties */
var sheet = {
name: 'pizza sheet!',
description: 'womp womp womp',
rows: [
{
pizza: 'pizza is really awesome!'
}
],
}
/* create a new sheet */
flatsheet.sheets.create(sheet, function(err, res){
console.log(err, res)
});
Update a sheet
flatsheet.sheets.get(sheetID, function (err, res) {
res.name = 'change the name of the sheet to this';
flatsheet.sheets.update(res, function (err, res) {
console.log(err, res)
});
});
Add a row to a sheet
var row = { pizza: 'wooaaaadddddaaaaoooo' };
flatsheet.sheets.addRow(sheetID, row, function (err, res) {
console.log(err, res);
});
Destroy a sheet
flatsheet.sheets.delete(sheetID, function () {
flatsheet.sheets.get(sheetID, function (err, res) {
console.log(err) /* { error: 404 } */
});
});
Tests
- Clone repository
- Run
npm install
- Run
npm test
Tests are currently located in the test.js file.