sadiq-tomtom-address-search

TypeScript Library for Address Search using TomTom API

This library provides a robust and efficient solution for parsing partial address inputs using the TomTom API. It is designed to be extensible, maintainable, and easily consumable in any LTS Node.js environment.

Getting Started

Place Search Documentation: https://developer.tomtom.com/search-api/documentation/searchservice/search-service

Project Setup

Prerequisites

• Node.js (v18 or later recommended)
• npm or yarn

Installation

1. Clone this repository
2. Install dependencies:

   npm install

3. Build with:

   npm run build

Getting a TomTom API Key

1. Sign up for a free account at TomTom Developer Portal
2. Create a new project and generate an API key
3. Copy the API key to your .env file

Scripts

• npm run build - Compile TypeScript to JavaScript
• npm run start - Run the compiled application
• npm run dev - Run the application using ts-node (without compiling)
• npm run lint - Lint the codebase

Project Structure

• src/ - Source code directory
  • index.ts - Main entry point
  • services/ - Service modules
    • tomtomService.ts - TomTom SDK integration
• release/ - Compiled JavaScript (generated after build)

Usage in Another Project

To use this library in another project, follow these steps:

1. Install the library:

   npm install sadiq-tomtom-address-search

2. Import and use the TomTomAddressService in your project:

   import { TomTomAddressService } from "sadiq-tomtom-address-search/release/index.js";
   
   const apiKey = 'your_api_key_here';
   const addressService = new TomTomAddressService(apiKey);
   
   addressService.searchAddress('37 Upper Leeson')
       .then(results => {
           console.log('Search results:', results);
           if (results && results.length > 0) {
               console.log(results);
           }
       })
       .catch(error => {
           console.error('Error while searching:', error);
       });

License

This project is licensed under the ISC License.