An npm package for Node.js to access detailed geographic data on Thailand, including provinces, districts, subdistricts, and postal code.
npm install geothai!NPM Version
Welcome to the GeoThai NPM Packages repository! 🌟 This repository provides an npm package for Node.js that allows you to retrieve detailed geographic data of provinces, districts, subdistricts, and postal code in Thailand.
This package includes functions to access and retrieve data about:
- Provinces
- Districts
- Subdistricts
- Postal Code
The data is sourced from comprehensive JSON files included in the package.
- Retrieve All Provinces: Fetch a list of all provinces in Thailand.
- Retrieve Province by ID: Get details of a specific province using its ID.
- Retrieve All Districts: Fetch a list of all districts.
- Retrieve District by ID: Get details of a specific district using its ID.
- Retrieve All Subdistricts: Fetch a list of all subdistricts.
- Retrieve Subdistrict by ID: Get details of a specific subdistrict using its ID.
- Retrieve All Postal Codes: Fetch a list of all postal codes.
- Retrieve Postal Code by Code: Get details of a specific postal code using its code.
- Filter by Criterion: Retrieve entities based on specific criteria.
You can install the package via npm:
``bash`
npm install geothai
Here’s a quick guide on how to use the package:
`typescript
import {
getAllProvinces,
getProvinceByCode,
getProvincesByCriterion,
} from "geothai";
// Retrieve all provinces
const provinces = getAllProvinces();
console.log(provinces);
// Retrieve a single province by code (with auto-completion)
const province = getProvinceByCode("10");
console.log(province);
// Retrieve provinces by a specific criterion
const filteredProvinces = getProvincesByCriterion({ name_th: "กรุงเทพมหานคร" });
console.log(filteredProvinces);
``
We welcome contributions to enhance this package. Please follow the guidelines in the CONTRIBUTING.md file.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or support, please open an issue or contact us at geothai@fasu.dev.
Happy coding! 🎉