/ohsome-js-utils

This library contains JavaScript functions to help clients to use the Ohsome-Api for analyzing historical OpenStreetMap data.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

status: experimental

Why is it experimental? It not yet fully supports all response types that the ohsome API can return. So currently it mainly supports the functionality needed in the ohsome Dashboard app.

Info

This library contains JavaScript functions to help clients to use the Ohsome-Api for analyzing historical OpenStreetMap data.

Functionality includes

  • parsing and validation of request params
  • type-guards, functions to access result values, conversion functions to create CSV output from JSON results

Usage

Installation

$> npm install @giscience/ohsome-js-utils

You can use this library in different ways.

1. UMD single file bundle for browsers or nodejs scripts

<script src="dist/ohsome-js-utils.umd.min.js"></script>
// nodejs
var OhsomeJsUtils = require( '@giscience/ohsome-js-utils' );

2. ES2020 modules

import * as OhsomeJsUtils from '@giscience/ohsome-js-utils'
// or
import { OhsomeApi } from '@giscience/ohsome-js-utils'