Thai Address Database

Common errors

• Cannot find module 'thai-address-database'

  cause The package has not been installed or is not correctly resolved by your module bundler/Node.js environment.
  fix Run `npm install thai-address-database` or `yarn add thai-address-database` in your project directory.

• searchAddressByDistrict is not a function

  cause The `searchAddressByDistrict` function was imported incorrectly, often due to attempting a default import or incorrect CommonJS `require`.
  fix Use a named import: `import { searchAddressByDistrict } from 'thai-address-database';`

• Error: ENOENT: no such file or directory, open '.../node_modules/thai-address-database/database/db.json'

  cause The `db.json` file, which contains the address data, is missing or inaccessible in the expected location.
  fix Ensure the package is fully installed and the database file is present. If you are developing or have manually altered the database, run `npm run migrate` to generate/restore `db.json` from `database.xlsx`.

Warnings

• gotcha The library currently only supports `db.json` for its address data. It does not support `db.zip` or `geodb` formats that might be present in related or original projects.
  Fix: Ensure your database is in `db.json` format. The package includes an `npm run migrate` script to convert `database.xlsx` to `db.json`.
• gotcha To update the local address database, you must use the provided `npm run migrate` command after modifying the `database.xlsx` file. Manual manipulation of `db.json` is not recommended as it can be overwritten.
  Fix: Run `npm run migrate` in your project's root directory after updating `database.xlsx`. Ensure the Excel file is always `.xlsx` format.
• gotcha This package is based on an older version (1.5.1) of the database and `preprocess()` function from `jquery.Thailand.js`. Be aware of potential differences in data structure or available functionality compared to newer versions of the original project.
  Fix: Refer to the `thai-address-database` documentation for specific functionality. If you require features or data from newer `jquery.Thailand.js` versions, you may need to contribute or seek alternatives.

Install

• npm install thai-address-database npm
• yarn add thai-address-database yarn
• pnpm add thai-address-database pnpm

Imports

• searchAddressByDistrict
  wrong:

  const searchAddressByDistrict = require('thai-address-database');
  import searchAddressByDistrict from 'thai-address-database';

  correct:

  import { searchAddressByDistrict } from 'thai-address-database';

  This package primarily uses named exports. Direct CommonJS `require` might not correctly expose the named functions, and it is not a default export.

Quickstart

Demonstrates how to import and use the `searchAddressByDistrict` function to query Thai address data, logging results to the console.

import { searchAddressByDistrict } from 'thai-address-database';

// In a browser environment, ensure db.json is accessible or bundled.
// For Node.js, the package typically handles database resolution.

// Simulate an input change or a search query
function performAddressSearch(query) {
  const results = searchAddressByDistrict(query);
  console.log(`\n--- Search results for "${query}" ---`);
  if (results && results.length > 0) {
    results.forEach(item => {
      console.log(`${item.district} » ${item.amphoe} » ${item.province} » ${item.zipcode}`);
    });
  } else {
    console.log("No matching addresses found.");
  }
}

// Example usage:
performAddressSearch('สีลม');
performAddressSearch('ดินแดง');
performAddressSearch('ปทุมวัน');
performAddressSearch('ถนนเพชรบุรีตัดใหม่'); // A query that might not yield direct district results
performAddressSearch('NonExistentPlace');