1.0.1 • Published 8 years ago

myjson-api v1.0.1

Weekly downloads
515
License
ISC
Repository
github
Last release
8 years ago

Overview

This is a simple wrapper for MyJSON.com the simple JSON store for your web or mobile app: http://myjson.com/

It has a Promise based syntax

npm install myjson

Then use it like this:

const myJsonAPI = require('myjson-api');

// Create a JSON object:
myJsonAPI.create({newBucketName:"New Bucket", counter: 0})
	.then((response) => console.log({id:response.id, uri:response.uri}))
    .error(() => )

// Get a JSON object:
myJsonAPI.get({binId})
	.then((json) => console.log(json))
    .error(() => )


// Get a JSON object:
myJsonAPI.update({binId, JSON})
	.then((updatedJSON) => console.log(updatedJSON)
    .error(() => )

Functions

get(binId) => {JSON}

The get function returns the JSON object associated with the bin id.

Kind: global function

ParamTypeDescription
binIdstringthe id of the bin you want to get the JSON for.

create() => {id, uri}

The create function creates a new myJSON bin(object). Returns to you the ID of the bin that was

Kind: global function Returns: string - binId - the id of the MyJSON bin(object) that was created

update(binId, jsonObject) => {JSON}

The update function allows you to update the JSON object associated with the bin id.

Kind: global function

ParamTypeDescription
binIdstringthe id of the bin you want to get the JSON for.
jsonObjectstringthe updated JSON object