npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

halo-api-wrapper

v1.1.0

Published

Node wrapper for the Halo API. Returns a Promise that will return the JSON from the API. Source available at

Downloads

6

Readme

Halo API Wrapper for Node JS

See https://googlrr.github.io/Halo-API-Wrapper-for-Node-JS/index.html for documentation!

Full Source Code available at https://github.com/Googlrr/Halo-API-Wrapper-for-Node-JS

Returns a Promise containing the JSON of the requested API Call.

List of API Calls found at https://developer.haloapi.com/docs/services/.

Check 'classes' in the documentation for a complete list of commands. Each command should have an example of how it should be used.

Install via NPM:

npm install --save halo-api-wrapper

Usage:

var haloWrapper = require('halo-api-wrapper');
var halo = new haloWrapper(YOUR_API_KEY);

//For Halo 5
halo.h5.stats.PCPlayerServiceRecords("googlrr").then((records) => {
  console.log(records.Results);
});

//For Halo Wars 2
halo.hw2.stats.playerMatchHistory('googlrr').then( (matches) => {
  console.log(matches);
});

//Calls are in the style of halo.game.APIType.CallofAPI(params)
//.then( (results) => {
//  stuff you want to do with results
//});

Full API should be covered now. Any issues please open an issue at https://github.com/Googlrr/Halo-API-Wrapper-for-Node-JS/issues and I'll look at it as soon as possible! In my expience (mostly with the Halo Wars 2 portions) all of the calls return results correctly.

Started mostly as a project to learn about working with asynchronous calls and promises in Node.js, I decided to complete the API wrapper to include full coverage of the Halo API.

This is purely a wrapper for the API and does not include any caching or rate limiting. I've thought about adding those but they're a bit out of the scope of what I was planning here. This is purely an easier way to interface with the Halo API. If you're looking to control your calls I recommend checking out this link: http://www.matteoagosti.com/blog/2013/01/22/rate-limiting-function-calls-in-javascript/. It has a pretty simple algorithm that should get some quick and dirty rate limiting going.