address-search-lib

A versatile TypeScript library for geocoding and address search using multiple providers.

Features

- Support for multiple geocoding providers:
- Google Maps
- Photon
- Nominatim (OpenStreetMap)
- LocationIQ
- Flexible API for easy integration
- TypeScript support

Installation

Install the package using npm

bash
npm install address-search-lib

Usage

$3

typescript

import { AddressSearch } from 'address-search-lib';
const addressSearch = new AddressSearch();
// Search using the default provider (Nominatim)
addressSearch.search('1600 Amphitheatre Parkway, Mountain View, CA')
.then(results => console.log(results))
.catch(error => console.error(error));

$3

typescript
// Use Google Maps geocoder
addressSearch.search('1600 Amphitheatre Parkway, Mountain View, CA', 'gg')
.then(results => console.log(results))
.catch(error => console.error(error));
// Use Photon geocoder
addressSearch.search('1600 Amphitheatre Parkway, Mountain View, CA', 'pton')
.then(results => console.log(results))
.catch(error => console.error(error));
// Use LocationIQ geocoder
addressSearch.search('1600 Amphitheatre Parkway, Mountain View, CA', 'iq')
.then(results => console.log(results))

$3

You can also use the geocoders individually:

typescript
import { GoogleGeocoder, NominatimGeocoder, PhotonGeocoder, LocationIQGeocoder } from 'address-search-lib';
const googleGeocoder = new GoogleGeocoder();
const nominatimGeocoder = new NominatimGeocoder();
const photonGeocoder = new PhotonGeocoder();
const locationIQGeocoder = new LocationIQGeocoder('your-api-key');
// Use Google Maps geocoder
googleGeocoder.geocode('1600 Amphitheatre Parkway, Mountain View, CA')
.then(results => console.log(results))
.catch(error => console.error(error));

Configuration

You can pass options when initializing the AddressSearch class:

typescript
const options = {
googleOptions: {
headless: false,
timeout: 60000
},
locationIQKey: 'your-locationiq-api-key'
};
const addressSearch = new AddressSearch(options);

API Reference

$3

- options: Optional configuration object
- googleOptions: Options for Google Maps geocoder
- locationIQKey: API key for LocationIQ
- place: The address or place to search for
- type: The geocoder to use (default: 'nomi')
- 'gg': Google Maps
- 'pton': Photon
- 'iq': LocationIQ
- 'nomi': Nominatim

$3

The GeocodingResult interface represents the structure of the geocoding results

Dependencies

- axios
- puppeteer-extra
- puppeteer-extra-plugin-stealth

License

This project is licensed under the MIT License.