Конфигурация

Загрузчик конфигурации поддерживает файлы yaml и json. Он может загрузить все файлы из каталога. И автоматически преобразует файл в указанный формат.

Установка

npm i @sumor/config --save

Предварительные требования

Версия Node.JS

Требуется версия Node.JS 16.x или выше

Требуется модуль ES Node.JS

Поскольку этот пакет написан в модуле ES, измените следующий код в вашем файле package.json:

{
  "type": "module"
}

Использование

Методы

load

• root: string - корневой каталог
• name: string - название файла
• ext: string - расширение файла для конвертации (yml, json)

find

* root: string - корневой каталог
* category: string - название категории
* ext: string - расширение файла для конвертации (yml, json)

Загрузка файла конфигурации

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// загрузит demo.yml или demo.json в корневом каталоге

const config2 = await load(process.cwd(), 'demo', 'yaml')
// загрузит demo.yml или demo.json в корневом каталоге и преобразует его в файл формата yaml

Поиск файлов конфигурации

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// загрузит все *.entity.yml или *.entity.json в корневом каталоге
/*
 * пример:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */