Node TipBot API

NPM Installation

---

$ npm install node-tipbot-api

Clone the project via github

---

$ git clone https://github.com/nrpatten/node-tipbot-api.git

• Then meet the package dependencies:

$ cd node-tipbot-api/
$ npm install

First steps

---

• include node-tipbot-api into your project:

vartipbot=require('node-tipbot-api');

Configuration options true or false

---

tipbot.options({'stream' : true,'cleartext' : true});

By default the returned data is an object, in order to get clear text you have to add the option cleartext (streams will always return objects):

Cleartext

• To activate Cleartext simply add to your options:

'cleartext' : true

Streams

• To activate Streaming simply add to your options:

'stream' : true

Example

---

sendCustomRequest

• url String
• callback Function

varurl='http://api.icndb.com/jokes/random';tipbot.sendCustomRequest(url,function(data){varinfo=data;console.log(info.value.joke);});