eventick
v1.1.3
Published
JavaScript wrapper around Eventick's API.
Downloads
12
Readme
.js 
JavaScript wrapper around Eventick's API. Amazingly backed by Promises and Functional Programming.
Usage
Grab it from npm:
npm install --save eventick
The lib has only one method, called login
. After logging in, the user will have access to the API.
Eventick.login(user, password)
- Type:
String -> String -> Promise
- Usage: enter credentials, the promise will resolve to an
Object
representing the API or throw anError Object
. Use.then()
and.catch()
rather than.then(ok, rejected)
.
Logged API:
token
- Type:
String
- Usage: normally you're not going to use this. however, if you'd need it, here it is.
events.get(id)
- Type:
Number -> Promise
- Usage: enter event's id, get a promise that will resolve to an
Object
containing event's data or throw anError Object
.
events.getList()
- Type:
(no param) -> Promise
- Usage: get a promise that will resolve to an
Array
containing events' data or throw anError Object
.
attendees.get(eventId, attendeeId)
- Type:
Number -> Number -> Promise
- Usage: enter event's id and attendee's id, get a promise that will resolve to an
Object
containing attendee's data or throw anError Object
.
attendees.getList(eventId)
- Type:
Number -> Promise
- Usage: get a promise that will resolve to an
Array
containing events' data or throw anError Object
.
###FAQ
- Yes, all methods are curried.
- Yes, all methods return promises.
- Do I need to know Functional Programming in order to use it? No.
- And what about promises? Yes.
License
MIT