fueleconomygov

Fuel Economy Gov
Perform chained queries on the fueleconomy.gov dataset

---

Overview · Install · Sample · API · Tests

---

Overview

Fuel Economy Gov allows you to search through vehicle records from the fueleconomy.gov website based on criteria you specify. You can find vehicles by make, model, year, MPG, etc.

Design - The queries follow a chaining pattern, allowing you to specify as few or as many constraints as you wish (see API list for details). Once the query is assembled, call .search() with a callback of the form cb(cars), where cars will be an array of records that met the criteria.

All the data (back to 1984) is packed in a .csv file obtained from the "Download the Vehicle Data" section of the .gov website. Integration with their web service API is expected for this module.

Why? This was made to support projects that provide vehicle search capabilities to users. The data is from fueleconomy.gov, so it's main focus is on fuel efficiency and emissions.

Install

npm install fueleconomygov

Sample

var FuelEconomy = require('fueleconomygov');
 
new FuelEconomy().make('Volkswagen').search(function(cars) {
    // `cars` will contain Volkswagen vehicles
});
 
new FuelEconomy().make('Jetta').search(function(cars) {
    // `cars` will contain Jettas (a model of Volkswagen)
});
 
// Queries can be chained together to be more specific
new FuelEconomy().make('Ford').minMpg(20).maxMpg(30).minYear(2005).maxYear(2018).search(function(cars) {
    // `cars` will contain any records that are Ford vehicles, with between 20-30mpg, and made between 2005 and 2018
});

API

The following functions can be chained together on the new FuelEconomy() clause to specify search constraints. As demonstrated above, call .search() with a callback to get the records found.

.make       string
.model      string
.year       number
.minYear    number
.maxYear    number
.mpg        number
.minMpg     number
.maxMpg     number

Tests

Run npm test to execute the Mocha tests. Each test takes a few seconds because the streaming query has to go through tens of thousands of records.