Skip to content
A data handler for the VATSIM Status System
JavaScript
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
test Updated tests and README to reflect new promise handling Oct 11, 2019
.gitignore Fixed issue 2 and updated README Oct 10, 2019
.jshintrc Updated tests and readme Oct 10, 2019
.travis.yml Added a new method, random url selection and cleaned up the code Oct 9, 2019
LICENSE Initial commit Oct 9, 2019
README.md
handler.js Fixed issue with promise being handled incorrectly (issue 3) Oct 10, 2019
package-lock.json Updated tests and README to reflect new promise handling Oct 11, 2019
package.json Updated tests and README to reflect new promise handling Oct 11, 2019

README.md

VATSIM Data Handler

A data handler for the VATSIM status system coded in JavaScript

Status

Check Provider Status
Build TravisCI build_status
Coverage Coveralls coverage_status
Discord Discord discord_badge
Github Version GitHub version_badge
License License license_badge

Installation

npm install vatsim-data-handler

Usage

const DataHandler = require('vatsim-data-handler');
const handler = new DataHandler();

handler.getSupervisors().then(val => console.log(val));

This would log the number of clients connected to the VATSIM network

Available methods

  • getCount(type) - Returns the number of connected clients, where type is the type of requested client. Available arguments are 'all', 'pilots' and 'controllers'
  • getAirportInfo(airport) - Returns the details of pilots into or out of a certain airport along with the controllers controlling that airport, the airport argument is a 4 letter ICAO code
  • getPopularAirports() - Returns a list of the top 10 airports for arriving and departing aircraft
  • getClientDetails(cid) - Returns the details of a specific pilots flight, where cid is a valid VATSIM cid as an integer
  • getSupervisors() - Returns a list of all the supervisors/admins connected to VATSIM

Deprecated - from v2.0.0 +


  • getClientCount() - Returns the number of clients connected to the VATSIM network (Replaced by getCount(type))
  • getPilotCount() - Returns the number of pilots connected to the VATSIM network (Replaced by getCount(type))
  • getControllerCount() - Returns the number of controllers connected to the VATSIM network (Replaced by getCount(type))

Tests

npm test

Support

If you have any issues or feature requests, either create an issue or you can join my Discord Server.

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

You can’t perform that action at this time.