flightplandb
v4.0.0
Published
An API wrapper for the website FlightPlanDatabase's API
Downloads
18
Maintainers
Readme
FlightPlanDB.js
An API wrapper for the website FlightPlanDatabase.com WARNING: THIS IS FOR SIMULATION USE ONLY. DO NOT USE FOR REAL WORLD NAVIGATION.
Use
To use the wrapper, simply import the FlightPlanDB module, and set a variable to a new instance of FlightPlanDB
. Call one of the attached methods, provide it the options it needs, and it will return the JSON object of the response. For example:
const flightPlanDb = import('FlightPlanDB');
const db = new flightPlanDb({API KEY HERE});
db.getWeather('KCLE', function(result) {
console.log(result);
});
Methods
getFlightPlan(id, callback)
-- Gets the flight plan from the database with the corresponding ID
getAirport(icao, callback)
-- Gets the airport information for a given ICAO code
getWeather(icao, callback)
-- Gets the METAR and TAF (if available) for the given ICAO airport
flightPlanQuery(query, callback)
-- Retrieves a search of all flightplans matching a query, including ICAOs, airport names, username, tags, or flight number
flightPlanFromTo(from, to, callback)
-- Retrieves a search of all flightplans from a location, to another
flightPlanIcaoFromTo(fromIcao, toIcao, callback)
-- Retrieves a search of all flightplans from a specific ICAO airport, to another
flightPlanFlightNumber(flightNumber, callback)
-- Retrieves a search of all flightplans with a given flight number
generateFlightPlan(fromIcao, toIcao, callback, useNat: true, usePacot: true, useAwylo: true, useAwyhi: true, cruiseAlt: 35000, cruiseSpeed: 420, ascentRate: 2500, ascentSpeed: 250, descentRate: 1500, descentSpeed: 250)
-- Generates a flight plan with the given parameters. All parameters after the callback function are optional, and defaults are shown.