osm-geojson

    0.8.4 • Public • Published

    osm-geojson

    Latest version on npm Downloads on npm Project license
    Lint status Test macOS status Test Ubuntu status Test Windows status
    Codecov Coverage report Known Vulnerabilities Dependency Status
    XO Code Style used AVA Test Runner used Istanbul Test Coverage used NI Scaffolding System used NP Release System used

    🔰 Get GeoJSON of a OpenStreetMap's relation from the API.
    Coded with ❤️ by Simone Primarosa.

    Install

    $ npm install --save osm-geojson
    

    Usage

    const osmGeoJson = require('osm-geojson');
     
    osmGeoJson.get('365331'); // Italy
    // => { type: 'GeometryCollection', geometries: [ { type: 'MultiPolygon', coordinates: [Array] } ] }
     
    osmGeoJson.getAll({'ITA': '365331', 'USA': '148838'}); // Italy
    // => {
    // 'ITA': { type: 'GeometryCollection', geometries: [ { type: 'MultiPolygon', coordinates: [Array] } ] },
    // 'USA': { type: 'GeometryCollection', geometries: [ { type: 'MultiPolygon', coordinates: [Array] } ] }
    // }

    CLI

    Install

    To use the CLI just install the package globally.

    $ npm install --g osm-geojson
    

    Or run it with npx if you are not planning to use it more than once.

    $ npx osm-geojson
    

    Help

    Usage
      $ osm-geojson <osmId>
      $ osm-geojson -l [<osmId>:<filename>]+
    Options
      -l  --list [<osmId>:<filename>]+   To fetch a list of osmIds. Each relation
                                         will be saved in a file called
                                         filename.geojson
      -p --pretty                        To beautify the outputted JSON.
    Examples
      $ osm-geojson 365331
      $ osm-geojson -p 365331
      $ osm-geojson -p 365331 > filename.geojson
      $ osm-geojson -l 365331:ita 148838:usa

    API

    get(osmid) ⇒ Promise.<object>

    Returns the GeoJSON of a particular OSM relation id.

    Returns: Promise.<object> - A promise that contains the GeoJSON of the given relation.

    Param Type Description
    osmid string Relation id from which extract the GeoJSON.

    getAll(map) ⇒ Promise.<object>

    Returns a map of GeoJSON of multiple OSM relation ids.

    Returns: Promise.<object> - A promise that contains the map with the same keys of the map provided but with the GeoJSON of the given relation id as value.

    Param Type Description
    map object Map from a name to a relation id from which extract the GeoJSON.

    Authors

    See also the list of contributors who participated in this project.

    License

    This project is licensed under the MIT License - see the license file for details.

    Install

    npm i osm-geojson

    DownloadsWeekly Downloads

    12

    Version

    0.8.4

    License

    MIT

    Unpacked Size

    14.5 kB

    Total Files

    5

    Last publish

    Collaborators

    • simonepri