0.1.0 • Published 9 years ago

yojs v0.1.0

Weekly downloads
4
License
MIT
Repository
github
Last release
9 years ago

YoJS

YoJS is a dead simple Node.js module for the Yo API.

Just Yo is the simplest and most efficient (zero) communication tool in the world.

YoJS's goal is simplicity. Because of this there is literally no error handling in the module. If something goes wrong then the response (in the callback) of the Yo API contains the error message and gives a non 200 HTTP status code.

NPM

Install

  • directly from the git repository: git clone https://github.com/Anubisss/yojs
  • from the npm registry: npm install yojs
  • from the bower registry: bower install yojs

Usage

var YoJS = require('yojs');

 // Your Yo account's API token/key.
 // Or you can set it via the YO_API_TOKEN environment variable.
var yoApiToken = '';
console.log('Trying to Yo...');
YoJS.yo('', yoApiToken, 'yoteam', '', '', function(err, res, body) {
  if (err) {
    console.log('Error: %s', err);
  } else {
    console.log('Success.');
  }
  console.log('res.statusCode: %s', res.statusCode);
  console.log('body: %s', body);
  // If you want to parse the body.
  var parsedBody = JSON.parse(body);
});

Examples

Examples for how to use YoJS are in the example directory. You have to set the YO_API_TOKEN environment variable to try out the examples. YO_API_TOKEN have to contain your Yo account's API token/key.

More details about the API

If you need more details about Yo's API then you should check this out: http://docs.justyo.co/v1.0/docs

License

The MIT License (MIT)