Skip to content

JavaScript client for the Geocode Earth API

Notifications You must be signed in to change notification settings

geocodeearth/core-js

Repository files navigation

Geocode Earth Core JS

This repository contains the Geocode Earth Core API client for JavaScript. As it is still under development not all APIs are implemented yet and the API itself may change in the future.

Implemented APIs

  • Autocomplete (/autocomplete)

Usage

import { createAutocomplete } from 'geocode-earth-core'
const autocomplete = createAutocomplete('ge-abc123')
autocomplete('berlin').then(console.log)

Params

createAutocomplete accepts parameters as a second argument, for example:

createAutocomplete('ge-abc123', {
  size: 5,
  focusPoint: {
    lat: 52.520008,
    lon: 13.404954
  }
})

All available parameters can be found in src/api/autocomplete/params.ts.

Build tooling

Commands

# creates ESM and CommonJS builds in `./dist`
$ npm run build

# runs tests
$ npm test

# removes dist folder
$ npm run clean

# run standard
$ npm run lint
$ npm run lint-fix # with auto fix