@souleymanefafabhe/sylidata v1.0.2
@souleymanefafabhe/sylidata
Le package @souleymanefafabhe/sylidata
fournit des données géographiques et administratives sous forme de JSON, incluant des informations sur les régions, les langues, les sous-préfectures, les préfectures, et les communes. Ce module permet de facilement accéder à ces données depuis votre projet Node.js.
Installation
Installez le package via npm
ou yarn
:
npm install @souleymanefafabhe/sylidata
ou
yarn add @souleymanefafabhe/sylidata
Utilisation
Une fois le package installé, vous pouvez l'importer et accéder aux données comme suit :
Installation
Installez le package en utilisant npm
ou yarn
:
npm install @souleymanefafabhe/sylidata
ou
yarn add @souleymanefafabhe/sylidata
Utilisation
Voici comment importer et utiliser le package dans votre code JavaScript :
const { rg, lg, sp, pr, cm } = require('@souleymanefafabhe/sylidata');
// Accéder à la liste des régions
const regions = rg();
console.log(regions);
// Accéder à la liste des langues
const languages = lg();
console.log(languages);
// Accéder aux sous-préfectures, préfectures et communes
const sousPrefectures = sp();
console.log(sousPrefectures);
const prefectures = pr();
console.log(prefectures);
const communes = cm();
console.log(communes);
Fonctions disponibles
rg()
: Renvoie un tableau des régions.lg()
: Renvoie un tableau des langues.sp()
: Renvoie un tableau des sous-préfectures, basé sur les régions.pr()
: Renvoie un tableau des préfectures, basé sur les régions.cm()
: Renvoie un tableau des communes, basé sur les régions.
Structure des données
Les données sont extraites de deux fichiers JSON :
region.json
: Contient des informations sur les régions, sous-préfectures, préfectures et communes.language.json
: Contient des informations sur les langues.
Exemple de structure pour region.json
:
[
{
"nom": "Région 1",
"sousprefectures": ["Sous-préfecture 1", "Sous-préfecture 2"],
"prefectures": ["Préfecture 1", "Préfecture 2"],
"communes": ["Commune 1", "Commune 2"]
}
]
Exemple pour language.json
:
[
{
"langue": "Français"
}
]
Contribuer
Les contributions sont les bienvenues. Si vous souhaitez contribuer au projet, suivez ces étapes :
- Fork le projet.
- Créez une branche pour vos modifications (
git checkout -b feature/nom-de-feature
). - Faites vos modifications.
- Soumettez une pull request.
License
Distribué sous la licence MIT. Voir le fichier LICENSE pour plus d'informations.