Package Exports

mapbox
mapbox/lib/get_user
mapbox/lib/services/datasets
mapbox/lib/services/geocoder

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (mapbox) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

mapbox-sdk-js

A node.js and browser JavaScript client to Mapbox services.

Services

Geocoding
- Forward (place names ⇢ longitude, latitude)
- Reverse (longitude, latitude ⇢ place names)
Directions
- Profiles for driving, walking, and cycling
- GeoJSON & Polyline formatting
- Instructions as text or HTML
Map Matching
- Aligns GPS trace data to roads and paths from OpenStreetMap data
Surface API
- Interpolates values along lines. Useful for elevation traces.
Upload API
- Upload data to be processed and hosted by Mapbox.

Installation

$ npm install --save mapbox

Usage

Basic usage of the geocoder:

var MapboxClient = require('mapbox');
var client = new MapboxClient('YOUR_ACCESS_TOKEN');
client.geocodeForward('Chester, NJ', function(err, res) {
  // res is the geocoding result as parsed JSON
});

sub-requiring individual services

Each service is available as a sub-require if you'd only like to include only its functionality and not the entire bundle. The returned MapboxClient will have the same constructor style but only include functions necessary for that service's support.

Available sub-requires:

geocoder: require('mapbox/lib/services/geocoder')
surface: require('mapbox/lib/services/surface')
matching: require('mapbox/lib/services/matching')
directions: require('mapbox/lib/services/directions')

mapbox