Full Documentation on GH Pages

Usage

Install

$ npm install challonge --save

Get all tournaments on your account

const challonge = require('challonge');

const client = challonge.createClient({
  apiKey: '***yourAPIKey***'
});

client.tournaments.index({
  callback: (err, data) => {
      console.log(err, data);
  }
});

Create a tournament

const challonge = require('challonge');

// create a new instance of the client
const client = challonge.createClient({
  apiKey: '***yourAPIKey***',
});

// create a tournament
client.tournaments.create({
  tournament: {
    name: 'new_tournament_name',
    url: 'new_tournament_url',
    tournamentType: 'single elimination',
  },
  callback: (err, data) => {
    console.log(err, data);
  }
});

API Client

createClient takes one argument for configuration and returns an instance of the api client. The configuration object can contain the following options:

  • apiKey string (required) - Your challonge API Key

  • subdomain string (optional) - Setting the subdomain automatically passes tournament[subdomain] and prefixes the subdomain to tournament urls. If you don't want to pass a subdomain to the constructor, and want to use an organization (or multiple organizations), you must use client.setSubdomain('subdomain') before making api calls.

  • format string (optional) - The format of the response data. Defaults to 'json'. If set to 'json', will return javascript objects. 'xml' will return the raw text string.

  • massageProperties boolean (optional) - If the response object should be massaged into camelCase properties when using json format. Defaults to true.

The wrapper is organized into resource.method to match the API

For API calls that require nested params (eg: http://api.challonge.com/v1/documents/tournaments/create) properties should be specified as a nested object:

{
  tournament: {
    name: 'new_tournament_name',
    url: 'new_tournament_url',
    tournamentType: 'single elimination',
  },
  callback: (err, data) => {}
}

All properties can be specified camelCase instead of using under_scores Both of the following are valid:

tournament: { tournamentType: 'single elimination' }
tournament: { tournament_type: 'single elimination' }

Development

Install

 $ git clone https://github.com/Tidwell/node-challonge
 $ cd node-challonge
 $ npm install

Run Tests

Build Status

$ npm test

Run JsFmt/JsHint

$ npm run-script format
$ npm run-script lint

All (travis integration tests)

$ npm run-script integrate

Issue Tracking

Issues are tracked on github: https://github.com/Tidwell/node-challonge/issues

The Zenhub Browser Plugin is used to organize issues.

The structure of this api wrapper is ripped off from https://github.com/nodejitsu/nodejitsu-api

Branching

master is the active development branch

live is the latest published build on npm