kenya-locations/dist/utils/search.d.ts

A comprehensive and intuitive TypeScript package for working with Kenyan administrative divisions (counties, sub-counties, constituencies, and wards)

import { SearchResult } from '../types';
/**
 * Available search types
 */
export type SearchType = "county" | "constituency" | "ward" | "sub-county" | "locality" | "area";
/**
 * Search across all levels of administrative divisions
 * @param query Search query string
 * @param options Search options
 * @param options.limit Maximum number of results (default: 10)
 * @param options.types Specific types to search (optional, searches all if not provided)
 * @returns Array of search results sorted by relevance and type hierarchy
 */
export declare function search(query: string, options?: {
    limit?: number;
    types?: SearchType[];
}): SearchResult[];
/**
 * Search for a specific type only
 * @param query Search query string
 * @param type The specific type to search for
 * @param limit Maximum number of results (default: 10)
 * @returns Array of search results for the specified type
 */
export declare function searchByType(query: string, type: SearchType, limit?: number): SearchResult[];