lions-arch
v0.2.4
Published
an implementation of the guild wars 2 api
Downloads
2
Readme
Lion's Arch
Lion's Arch is a (yet another) library for accessing the Guild Wars 2 API. It is fully compatible with Node and IOJS and uses callbacks as it's primary response mechanism. It's also lightweight; you can pick and choose the features you want by simply requiring the module you want (see the Features section for more info).
Features
- /v2/account/materials -
require('lions-arch/account/materials')
I've made the decision to keep each of the sections distinct and forego a file that joins them. I will likely change this in the future, but for now, you'll have to require the modules individually. I know this violates the principle of least surprise. Sorry. :(
Why callbacks?
Because callbacks are lightweight and supported, natively, by all versions of Node without external dependencies. It frees the user up to use fantastic libraries such as async
or highland
, as well as implement their own promises on top, through bluebird
. I'm a promise man myself, but I figured that when I created this library the (vast) majority of users will still not have moved over to ES6/IoJS. As a result, we use callbacks. Maybe at some point in the future I will add the ability to omit the callback argument for Promises, but not right now.
Contributing
I'd love to have any contributions you have to offer. Please make your changes on a feature branch in your own fork and make sure to add tests! I use nock
and mocha
with plain ol' assert
for the tests so far, so I'd like you to do the same. Please don't use any ES6 syntax either (at least not until Node supports it without flags).
Keep the commit notes descriptive of what each one does - if you're stuck, look at how I've done my commit notes. If your pull request is decent and has tests, I'll likely accept it. If not, I'm more than happy to instruct you on changes that you need to make before it can be merged.