Miss any of our Open RFC calls?Watch the recordings here! »

@mapbox/osm-compare

9.3.2 • Public • Published

osm-compare

Circle CI

Compare functions are small atomic functions that are designed identify what changed during a feature edit on OpenStreetMap. Compare functions can be broadly split up into two categories:

  1. Property (tags) checking compare function
  2. Geometry checking compare functions

Compare functions take as inputs the following:

  1. oldVersion - GeoJSON of the feature's old version
  2. newVersion - GeoJSON of the feature's new version

Compare functions output the following:

  1. result - Object containing key value pairs representing findings of the compare function or an empty object.
# Format of compare function result where value can be primary data types or objects 
{
    'result:comparator_name': value,
    'message': Any custom message which corresponds to the catch
}
 
# Format of compare function if no result, (default) 
false
 

Install

# Install osm-compare from the Mapbox namespace. 
npm install @mapbox/osm-compare

Docs

How do I build an npm package?

Keywords

none

Install

npm i @mapbox/osm-compare

DownloadsWeekly Downloads

3

Version

9.3.2

License

ISC

Unpacked Size

9.48 MB

Total Files

234

Last publish

Collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
  • avatar