french-city/lib/index.d.ts

Une bibliothèque Node.js fournissant la liste complète des villes françaises

import { City } from './types';
export * from './types';
export * from './data';
/**
 * Recherche une ville par son nom exact
 * @param name Le nom exact de la ville
 * @returns La ville ou undefined si non trouvée
 */
export declare const getCityByExactName: (name: string) => City | undefined;
/**
 * Recherche des villes par nom partiel
 * @param name Une partie du nom de la ville
 * @returns Un tableau des villes correspondantes
 */
export declare const searchCitiesByName: (name: string) => City[];
/**
 * Récupère toutes les villes d'un département
 * @param departement Le nom du département
 * @returns Un tableau des villes du département
 */
export declare const getCitiesByDepartement: (departement: string) => City[];
/**
 * Récupère toutes les villes d'un code postal
 * @param codePostal Le code postal
 * @returns Un tableau des villes correspondantes
 */
export declare const getCitiesByPostalCode: (codePostal: string) => City[];