@ourstreets/plate-lookup-utils

Utility library for the plate lookup.

API

Table of Contents

• getBoundary
  • Parameters
• getAllBoundaries
• getNearbyRegions
  • Parameters

getBoundary

Get a simplified boundary as GeoJSON of an OSM relation

Parameters

• osmRelationId number The OSM Relation ID to generate GeoJSON for

Returns Promise<Object> simplified GeoJSON of the OSM relation

getAllBoundaries

Get all simplified boundaries for the jurisdictions @ourstreets/plate-lookup supports and write them to disk in a folder named regions

Returns Promise<undefined> resolves when done

getNearbyRegions

Get nearby regions to a point.

Parameters

• point object GeoJSON representation of a point
• options object buffer, units, and regions

Returns Promise<Object> simplified GeoJSON of the OSM relation

getBoundary

Get a simplified boundary as GeoJSON of an OSM relation

Parameters

• osmRelationId number The OSM Relation ID to generate GeoJSON for

Returns Promise<Object> simplified GeoJSON of the OSM relation