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

fueleconomygov

v1.0.0

Published

Perform chained queries on the fueleconomy.gov dataset

Downloads

8

Readme

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.