kenya-locations/dist/constituencies.d.ts

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

import { Constituency, Ward, County } from './types';
/**
 * Constituency wrapper class with methods to access related data
 */
export declare class ConstituencyWrapper {
    private readonly _data;
    constructor(data: Constituency);
    /** Get the constituency code */
    get code(): string;
    /** Get the constituency name */
    get name(): string;
    /** Get the county this constituency belongs to */
    get county(): string;
    /** Get all data for the constituency */
    get data(): Constituency;
    /**
     * Get all wards in this constituency
     */
    wards(): Ward[];
    /**
     * Get a ward in this constituency by name or code
     */
    ward(nameOrCode: string): Ward;
    /**
     * Get the county this constituency belongs to
     */
    getCounty(): County | undefined;
}
/**
 * Get all constituencies
 * @returns Array of all constituencies
 * @example
 * ```ts
 * import { getConstituencies } from 'kenya-locations/constituencies';
 * const constituencies = getConstituencies();
 * ```
 */
export declare function getConstituencies(): Constituency[];
/**
 * Get a constituency by code
 * @param code Constituency code
 * @returns ConstituencyWrapper instance or undefined if not found
 * @example
 * ```ts
 * import { getConstituencyByCode } from 'kenya-locations/constituencies';
 * const constituency = getConstituencyByCode('001');
 * ```
 */
export declare function getConstituencyByCode(code: string): ConstituencyWrapper | undefined;
/**
 * Get a constituency by name
 * @param name Constituency name (case-insensitive)
 * @returns ConstituencyWrapper instance or undefined if not found
 * @example
 * ```ts
 * import { getConstituencyByName } from 'kenya-locations/constituencies';
 * const westlands = getConstituencyByName('Westlands');
 * ```
 */
export declare function getConstituencyByName(name: string): ConstituencyWrapper | undefined;
/**
 * Get all wards in a constituency by name or code
 * @param constituencyNameOrCode Constituency name or code
 * @returns Array of wards in the constituency
 * @example
 * ```ts
 * import { getWardsInConstituency } from 'kenya-locations/constituencies';
 * const wards = getWardsInConstituency('Westlands');
 * ```
 */
export declare function getWardsInConstituency(constituencyNameOrCode: string): Ward[];
/**
 * Get the county that a constituency belongs to
 * @param constituencyNameOrCode Constituency name or code
 * @returns County object or undefined if not found
 * @example
 * ```ts
 * import { getCountyOfConstituency } from 'kenya-locations/constituencies';
 * const county = getCountyOfConstituency('Westlands');
 * ```
 */
export declare function getCountyOfConstituency(constituencyNameOrCode: string): County | undefined;
export type { Constituency };