@ban-team/fantoir
v0.15.1
Published
Toolkit for FANTOIR data manipulation in JS
Downloads
19
Keywords
Readme
@ban-team/fantoir
Bibliothèque permettant d'interroger facilement la base FANTOIR.
Pré-requis
Cette bibliothèque nécessite Node.js version 10 ou supérieur.
Installation
yarn add @ban-team/fantoir
Utilisation
const {createFantoirCommune} = require('@ban-team/fantoir')
const fantoirCommune = await createFantoirCommune('54099', options)
// Rechercher une voie
fantoirCommune.findVoie('rue du parc')
// Rechercher une voie en indiquant une commune membre
fantoirCommune.findVoie('rue du parc', '54342')
Production de la base au format SQLite (développement)
zcat fantoir-* | yarn build
Configuration
Le chemin vers la base FANTOIR doit être renseigné soit via l’option fantoirPath
soit via la variable d’environnement FANTOIR_PATH
.
Les entrées FANTOIR annulées des communes fusionnées sont chargées par défaut. Pour ne charger que le code demandé, il faut renseigner l’option withAnciennesCommunes: false
.
Licence
MIT