# thaizip documentation

> Headless fuzzy search for Thai addresses (subdistrict, district, province, postal code) with Thai and English input. Zero runtime dependencies, optional React hook.

- [Full documentation](https://naay99999.github.io/thai-zip/llms-full.txt): every page below in one file
- [react-thaizip documentation](https://react-thai-zip.vercel.app/llms.txt): ready-made React components built on thaizip, scaffolded by a CLI

## ไทย

### ภาพรวม

- [thaizip](https://naay99999.github.io/thai-zip/index.md): ค้นหาที่อยู่ไทยแบบ autocomplete — ตำบล อำเภอ จังหวัด รหัสไปรษณีย์

### เริ่มต้น

- [เริ่มต้นใช้งาน](https://naay99999.github.io/thai-zip/getting-started.md): ติดตั้ง thaizip แล้วค้นหาที่อยู่ไทยแบบ fuzzy ได้ในไม่กี่บรรทัด

### คู่มือ

- [การค้นหา](https://naay99999.github.io/thai-zip/guides/search.md): ตัวเลือกของ searchThaiAddress การจัดอันดับผลลัพธ์ และข้อจำกัดที่ควรรู้
- [ค้นหาด้วยรหัสไปรษณีย์](https://naay99999.github.io/thai-zip/guides/zip-lookup.md): พฤติกรรมของการค้นหาด้วยรหัสไปรษณีย์ และเหตุผลที่รหัสไปรษณีย์ครบ 5 หลักไม่ถูกจำกัดจำนวนผลลัพธ์โดยค่าเริ่มต้น
- [Dropdown จังหวัด → อำเภอ → ตำบล](https://naay99999.github.io/thai-zip/guides/cascade.md): API สำหรับสร้าง dropdown แบบลดหลั่นจากจังหวัดไปจนถึงตำบล และรหัสไปรษณีย์
- [ค้นหาด้วยภาษาอังกฤษ](https://naay99999.github.io/thai-zip/guides/english-input.md): การสะกดแบบ RTGS ที่ค้นหาได้ทันที และรายการ alias สำหรับคำสะกดที่ไม่ใช่ RTGS
- [React Hook](https://naay99999.github.io/thai-zip/guides/react.md): useThaiAddressAutocomplete จาก thaizip/react — debounce, state, และ API ที่ได้คืนมา
- [ใช้ข้อมูลของคุณเอง](https://naay99999.github.io/thai-zip/guides/custom-data.md): สร้าง index จากข้อมูลของคุณเองด้วย buildThaiAddressIndex แทนข้อมูล default ที่แถมมากับไลบรารี
- [Playground](https://naay99999.github.io/thai-zip/playground.md): ทดลองปรับตัวเลือกทั้งหมดของ searchThaiAddress แล้วดูผลลัพธ์แบบสด ๆ

### API Reference

- [search](https://naay99999.github.io/thai-zip/reference/search.md): อ้างอิง API ของ searchThaiAddress, lookupByZipCode และฟังก์ชันเสริมที่ใช้ในเบื้องหลัง
- [enumerate](https://naay99999.github.io/thai-zip/reference/enumerate.md): อ้างอิง API ของ listProvinces, listAmphures, listTambons สำหรับสร้าง dropdown แบบลดหลั่น
- [formatter](https://naay99999.github.io/thai-zip/reference/formatter.md): อ้างอิง API ของ formatThaiAddressSuggestion — แปลง ThaiAddressRecord เป็น ThaiAddressSuggestion สำหรับแสดงผล
- [resolver](https://naay99999.github.io/thai-zip/reference/resolver.md): อ้างอิง API ของ resolveThaiAddress — แปลง ThaiAddressRecord เป็นออบเจ็กต์ที่อยู่แบบเต็มพร้อมชื่อ field สองชุด
- [data](https://naay99999.github.io/thai-zip/reference/data.md): อ้างอิง API ของ loadDefaultIndex, clearDefaultIndex, buildThaiAddressIndex และ validateRawData
- [react](https://naay99999.github.io/thai-zip/reference/react.md): อ้างอิง API ของ useThaiAddressAutocomplete จาก thaizip/react — ตัวเลือกทั้งหมดและค่าที่คืนกลับ
- [types](https://naay99999.github.io/thai-zip/reference/types.md): อ้างอิง type ทั้งหมดที่ thaizip export ออกมา — ThaiAddressRecord, TrigramIndex, SearchOptions และอื่น ๆ

## English

### Overview

- [thaizip](https://naay99999.github.io/thai-zip/en/index.md): Fast fuzzy autocomplete for Thai addresses

### Start Here

- [Getting Started](https://naay99999.github.io/thai-zip/en/getting-started.md): Install thaizip and search Thai addresses with fuzzy matching in a few lines

### Guides

- [Searching](https://naay99999.github.io/thai-zip/en/guides/search.md): searchThaiAddress options, how results are ranked, and known limitations
- [Postal Code Lookup](https://naay99999.github.io/thai-zip/en/guides/zip-lookup.md): How postal-code search behaves, and why a full postal code is never capped by default
- [Cascade Dropdowns](https://naay99999.github.io/thai-zip/en/guides/cascade.md): The province → district → subdistrict enumeration API, and how it exposes postal codes
- [English Input](https://naay99999.github.io/thai-zip/en/guides/english-input.md): RTGS spellings that work out of the box, and the alias list for non-RTGS spellings
- [React Hook](https://naay99999.github.io/thai-zip/en/guides/react.md): useThaiAddressAutocomplete from thaizip/react — debounce, state, and its return values
- [Custom Data](https://naay99999.github.io/thai-zip/en/guides/custom-data.md): Build an index from your own data with buildThaiAddressIndex instead of the bundled default dataset
- [Playground](https://naay99999.github.io/thai-zip/en/playground.md): Try every searchThaiAddress option and see the results live

### API Reference

- [search](https://naay99999.github.io/thai-zip/en/reference/search.md): API reference for searchThaiAddress, lookupByZipCode, and the helper functions behind them
- [enumerate](https://naay99999.github.io/thai-zip/en/reference/enumerate.md): API reference for listProvinces, listAmphures, and listTambons — the cascade dropdown enumeration API
- [formatter](https://naay99999.github.io/thai-zip/en/reference/formatter.md): API reference for formatThaiAddressSuggestion — turns a ThaiAddressRecord into a ThaiAddressSuggestion for display
- [resolver](https://naay99999.github.io/thai-zip/en/reference/resolver.md): API reference for resolveThaiAddress — turns a ThaiAddressRecord into a full address object with two naming conventions
- [data](https://naay99999.github.io/thai-zip/en/reference/data.md): API reference for loadDefaultIndex, clearDefaultIndex, buildThaiAddressIndex, and validateRawData
- [react](https://naay99999.github.io/thai-zip/en/reference/react.md): API reference for useThaiAddressAutocomplete from thaizip/react — every option and every returned value
- [types](https://naay99999.github.io/thai-zip/en/reference/types.md): Reference for every type thaizip exports — ThaiAddressRecord, TrigramIndex, SearchOptions, and more