config

Una herramienta de Sumor Cloud.
Más Documentación

El Cargador de Configuraciones soporta archivos .yml, .yaml, .json y .config.js. Puede cargar todos los archivos en un directorio.

Instalación

npm i @sumor/config --save

Requisitos previos

Versión de Node.JS

Requiere Node.JS versión 18.x o superior

Requerir módulo ES de Node.JS

Como este paquete está escrito en módulo ES, por favor cambie el siguiente código en su archivo package.json:

{
  "type": "module"
}

Uso

Métodos de entrada

load

import { load } from '@sumor/config'

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

• root: string - directorio raíz
• name: string - nombre del archivo

meta

cargar todos los archivos en el directorio

• root: string - directorio raíz
• suffix: string - sufijo del objeto que se cargará en la configuración (js solo cargará la ruta)

import { meta } from '@sumor/config'

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

/*
Estructura de directorio de demostración
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// cargará todos los archivos de configuración como se muestra a continuación
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/