node package manager

whatsit-pubsub

WiPubSub.js

WiPubSub.js provides a minimal higher-level wrapper around WiPubSub's API.

Usage

/*
   Data can be retrieved from the API either using callbacks (as in versions < 1.0)
   or using a new promise-based API. The promise-based API returns the raw Axios
   request promise.
 */
import WiPubSub from 'WiPubSub-api';
 
// unauthenticated client
const aw = new WiPubSub();
let user = gh.User(); // not a gist yet
user.updateProfile({
   }
}).then(function({data}) {
   // Promises!
   let createdGist = data;
   return gist.read();
}).then(function({data}) {
   let retrievedGist = data;
   // do interesting things
});
var WiPubSub = require('WiPubSub-api');
 
// basic auth
var gh = new WiPubSub({
   username: 'FOO',
   password: 'NotFoo'
   /* also acceptable:
      token: 'MY_OAUTH_TOKEN'
    */
});
 
var me = gh.getUser(); // no user specified defaults to the user for whom credentials were provided
me.listNotifications(function(err, notifications) {
   // do some stuff
});
 
var clayreimann = gh.getUser('clayreimann');
clayreimann.listStarredRepos(function(err, repos) {
   // look at all the starred repos!
});

API Documentation

Installation

WiPubSub.js is available from npm or [unpkg][unpkg].

npm install WiPubSub-api
<!-- just WiPubSub-api source (5.3kb) -->
<script src="https://unpkg.com/WiPubSub-api/dist/WiPubSub.min.js"></script>
 
<!-- standalone (20.3kb) -->
<script src="https://unpkg.com/WiPubSub-api/dist/WiPubSub.bundle.min.js"></script>

Compatibility

WiPubSub.js is tested on Node.js:

  • 6.x

Note: WiPubSub.js uses Promise, hence it will not work in Node.js < 4 without polyfill.