1.0.1 • Published 9 months ago

openstreetmap-node v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

A simple API Wrapper for OpenStreetMap in Typescript.

This package provides a simple wrapper for the usage of OpenStreetMap API in Node.js.

Supported APIs

Client Usage

Installation

yarn add openstreetmap-node

Initialize Client

import { OpenStreetMap } from "openstreetmap-node";

const client = new OpenStreetMap();

Lookup Postal Code

    // Single lookup
    // returns a single object {lat: number, lon: number, country: string}
    const singleLookup = await client.fetchCoordinates("90210", "US");
    
    // Bulk lookup
    // returns an array of objects [{lat: number, lon: number, country: string}]
    const bulkLookup =  await client.fetchCoordinates(["90210", "93108"], "US");
    
    // Multiple countries
    // returns an array of objects [{lat: number, lon: number, country: string}]
    const multipleCountries =  await client.fetchCoordinates([{zip: "90210", country: "US"}, {zip: "10243", country: "DE"}]);

Created under the MIT License

1.0.1

9 months ago

1.0.0

9 months ago