🔍 @worldkit/search

Ultra-fast (<3ms) multi-entity search engine for countries, currencies, cities, and languages.

Perform instant fuzzy multi-entity queries across all WorldKit datasets in under 3ms execution time.

📚 Full Documentation: https://worldkit.in/docs/search

⚡ Features

• 🚀 Sub-3ms Speed: In-memory relevance ranking algorithm delivers instant results for autocomplete search inputs.
• 🌐 Multi-Entity Search: Searches across countries, currencies, cities, and languages in a single function call.
• 🎯 Relevance Scoring: Ranks exact matches, prefix matches, and fuzzy matches automatically.
• 📦 Micro Footprint: ~1.9 KB gzipped with zero external dependencies.

📦 Install

npm install @worldkit/search
# or
pnpm add @worldkit/search
# or
yarn add @worldkit/search

💡 Usage

import { search } from "@worldkit/search";

// 1. Search across all entities
const results = search("Tokyo");
console.log(results);
/*
[
  {
    type: "city",
    id: 1,
    name: "Tokyo",
    code: "JP",
    score: 90,
    item: { name: "Tokyo", country: "JP", lat: 35.6762, lng: 139.6503 }
  }
]
*/

// 2. Filter search by specific entity types
const countryResults = search("Japan", {
  types: ["country", "currency"],
  limit: 5
});

📖 API Reference

search(query: string, options?: SearchOptions): SearchResult[]

Performs ranked fuzzy multi-entity search across global datasets.

Options:

• limit?: number: Maximum number of results to return (default: 20).
• types?: Array<"country" | "currency" | "city" | "language">: Restrict search target entities.

📐 TypeScript Support

Includes strict TypeScript definitions:

import type { SearchResult, SearchOptions } from "@worldkit/search";

🔗 Related Packages

Explore the rest of the WorldKit ecosystem:

• @worldkit/core - Unified global data facade.
• @worldkit/cli - Terminal search CLI tool.
• @worldkit/react - React UI search & select components.

📜 License

MIT © WorldKit