Code Monkey home page Code Monkey logo

hamster's Introduction

hamster.js

An asynchronous EVE Online API client for Node.js

Examples

var hamster = require('hamster')

// Print a list of skill groups
hamster.fetch('eve:SkillTree', function (err, result) {
  if (err) throw err

  for (var groupID in result.skillGroups) {
    console.log(result.skillGroups[groupID].groupName)
  }
})

// Set default parameters (useful for setting keyID and vCode)
hamster.setParams({
  keyID: '1234567',
  vCode: 'some random vcode'
})

// Default parameters will get merged with the parameters passed into fetch().
// The actual request will include all three parameters: keyID, vCode and characterID
hamster.fetch('char:AccountBalance', {characterID: 12345}, function (err, result) {
  if (err) throw err
  // do stuff
})

Client object

The hamster object is multi-purpose in that it is both a namespace container and an instance of hamster.Client. Client objects individually maintain their own cache state and server details. If you do not want to use the default hamster object, feel free to construct your own client objects as you see fit.

var hamster = require('hamster')
  , client = new hamster.Client({url: url, cache: cache})

client.fetch('...', function (err, result) {
  // ...
})

Caching

  • Easily extendible
  • Asynchronous store/read
  • Ships with hamster.cache.FileCache and hamster.cache.MemoryCache
  • Defaults to hamster.cache.MemoryCache (it is highly recommended you switch to FileCache)
var hamster = require('hamster')

hamster.setCache(new hamster.cache.FileCache({path: '...'}))

Tests

Hamster is mostly tested, but not completely. Any contributions, especially to tests are greatly appreciated.

Run tests with (requires mocha):

npm test

License

Hamser is licensed under the MIT license:

Copyright (c) 2012 Matt Harris

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial
portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

hamster's People

Contributors

blub0hr avatar kuja avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.