Pelias category taxonomy definition
JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
test
.gitignore
.jshintignore
.jshintrc
.npmrc
.travis.yml
LICENSE
README.md
index.js
package.json

README.md

This repository is part of the Pelias project. Pelias is an open-source, open-data geocoder built by Mapzen that also powers Mapzen Search. Our official user documentation is here.

pelias-categories

Greenkeeper badge

This module is intended to represent the Pelias category taxonomy. It is the place to ask what categories exist, as well as what tags they correspond to in various data sets.

Installation

npm install pelias-categories

Usage

var categories = require('pelias-categories');

if (categories.isValidCategory('food')) {
  console.log('food is a valid category');
}

Contributing

Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests. 🎉

Unit tests

You can run the unit test suite using the command:

$ npm test