config

A Sumor Cloud Tool.
More Documentation

Config Loader support .yml, .yaml, .json and .config.js files. It can load all files in a directory.

Installation

npm i @sumor/config --save

Prerequisites

Node.JS version

Require Node.JS version 18.x or above

require Node.JS ES module

As this package is written in ES module, please change the following code in your package.json file:

{
  "type": "module"
}

Usage

entry methods

load

import { load } from '@sumor/config'

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

• root: string - root directory
• name: string - file name

meta

load all files in the directory

• root: string - root directory
• suffix: string - object suffix which will be load into config (js will only load path)

import { meta } from '@sumor/config'

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

/*
Demo directory structure
- root
  - car.json
  - car.sql
  - ship.js
  - plane.yml
  - truck.config.js
*/

// it will load all config files as below
/*
{
  car: {
    name: 'car',
    sql: "..."
  },
  ship: {
    name: 'ship'
    js: '<root>/ship.js'
  },
  plane: {
    name: 'plane'
  },
  truck: {
    name: 'truck'
  }
*/