config

Un outil Sumor Cloud.
Plus de documentation

Le chargeur de configuration prend en charge les fichiers .yml, .yaml, .json et .config.js. Il peut charger tous les fichiers d'un répertoire.

Installation

npm i @sumor/config --save

Prérequis

Version de Node.JS

Nécessite Node.JS version 18.x ou supérieure

Nécessite le module ES de Node.JS

Comme ce package est écrit en module ES, veuillez modifier le code suivant dans votre fichier package.json :

{
  "type": "module"
}

Utilisation

Méthodes d'entrée

load

import { load } from '@sumor/config'

const config = await load(process.cwd(), 'config')
// chargera config.yml, config.yaml, config.json, config.config.js

• root: string - répertoire racine
• name: string - nom du fichier

meta

charge tous les fichiers dans le répertoire

• root: string - répertoire racine
• suffix: string - suffixe de l'objet qui sera chargé dans la configuration (js ne chargera que le chemin)

import { meta } from '@sumor/config'

const config = await meta(process.cwd(), ['js', 'sql'])

/*
Structure du répertoire de démonstration
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// chargera tous les fichiers de configuration comme suit
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/