Code Monkey home page Code Monkey logo

france-cities-js's Introduction

FRANCE CITIES JS

Search and get informations about french cities from the package offline database.
Database comes from Stanislas-Poisson/French-zip-code

Installation

yarn add "france-cities-js"

npm install --save "france-cities-js"

Usage

// ESM
import { searchCity, searchDepartment, searchRegion } from "france-cities-js";
// CJS
const { searchCity, searchDepartment, searchRegion } = require("france-cities-js");

// parameters : string to search and limit number of results
const cities1 = searchCity.byName("plou", 10);
const cities2 = searchCity.byDepartmentCode("29", 10);
const cities2 = searchCity.byInseeCode("010", 10);
const cities3 = searchCity.byZipCode("772", 10);

const departments1 = searchDepartment.byName("seine", 10);
const departments2 = searchDepartment.byDepartmentCode("56", 10);
const departments3 = searchDepartment.byRegionCode("8", 10);

const regions1 = searchRegion.byName("re", 10);
const regionn2 = searchRegion.byCode("8", 10);

Types

type City = {
    id: number;
    department_code: string;
    insee_code: string;
    zip_code: string;
    name: string;
    slug: string;
    gps_lat: number;
    gps_lng: number;
};

type Department = {
    id: number;
    code: string;
    region_code: string;
    name: string;
    slug: string;
};

type Region = {
    id: number;
    code: string;
    name: string;
    slug: string;
};

france-cities-js's People

Stargazers

Ramzi Laifa avatar

Watchers

James Cloos avatar christophe avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.