flowdock-ex
v1.3.1
Published
Flowdock client for NodeJS with higher level functionality
Downloads
75
Maintainers
Readme
Flowdock EX
It's like the flowdock module, but EXtended. It's way easier and better to use.
The module is of course made for Node.JS and should be used to completely replace your use of flowdock
currently.
Features:
- Higher level, so there's less raw data manipulation
- Things make more sense
- Easier to access all your client's flows, organizations, users
- Easier to message people
- Soon it will also be way easier to thread messages (I hate flowdock's threading API so currently don't want to deal with that PITA)
- Easier to stream and manage streams
- Everything uses promises rather than callbacks
- Supports the ability to detect when you join a flow (or multiple at once)
- Similarly, you can now automagically listen for new messages without having to do a bunch of stream manipulation on your own.
- It's just better, use this instead of the regular flowdock module and you probably won't be sorry
- Even if it's missing a feature, you can still access the full flowdock api (and I've wrapped the request so it uses promises instead)
- I really dislike flowdock's API and documentation, but this module makes me not want to die when using it.
That's pretty much it.
Usage:
const { FlowdockClient } = require('flowdock-ex');
const client = new FlowdockClient({ session: MY_TOKEN });
client.init()
.then(() => {
client
.stream(...Array.from(client.flows.values()))
.on('event', ...);
})
.catch(console.error)
This will create a client, initialize it, and then stream all of its flows at once, then use the resulting event emitter to listen for events. Note that this is not best practice, because you won't be able to clean up the FlowStream returned by Client#stream.
Though I was too lazy for v0.0.1, stuff will eventually be documented and viewable with jsdoc, but for now just poke around and look at it. There's not a whole lot to it for the time being.
You can also use the non-babel transpiled version by requiring flowdock-ex/src
rather than just flowdock-ex
, if you want that minimal performance gain.
Migration from the flowdock module
If you want to use the snazzy new features without having to migrate any code, just use the session property from Client.session while you do your migration.