config

Ein Sumor Cloud Tool.
Weitere Dokumentationen
Der Config Loader unterstützt yaml- und json-Dateien. Er kann alle Dateien in einem Verzeichnis laden.
Und konvertiert automatisch die Datei in das angegebene Format.

Installation

npm i @sumor/config --save

Voraussetzungen

Node.JS-Version

Benötigt Node.JS-Version 16.x oder höher

Benötigt Node.JS ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, ändere bitte den folgenden Code in deiner package.json-Datei:

{
  "type": "module"
}

Verwendung

Methoden

load

• root: string - Root-Verzeichnis
• name: string - Dateiname
• ext: string - Dateierweiterung zum Konvertieren (yml, json)

find

* root: string - Root-Verzeichnis
* category: string - Kategoriename
* ext: string - Dateierweiterung zum Konvertieren (yml, json)

findReference

* root: string - Root-Verzeichnis
* references: array - Bezug auf Dateierweiterung (vue, js)
* ext: string - Dateierweiterung zum Konvertieren (yml, json)

Konfigurationsdatei laden

import { load } from '@sumor/config'

const config1 = await load(process.cwd(), 'demo')
// Lädt demo.yml oder demo.json im Root-Verzeichnis

const config2 = await load(process.cwd(), 'demo', 'yaml')
// Lädt demo.yml oder demo.json im Root-Verzeichnis und konvertiert es in das yaml-Format

Konfigurationsdateien finden

import { find } from '@sumor/config'

const config = await find(process.cwd(), 'entity')
// Lädt alle *.entity.yml oder *.entity.json im Root-Verzeichnis
/*
 * Beispiel:
 *   car.entity.yml, bike.entity.json
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */

Konfigurationsdateien aus anderen Dateien finden

wie z.B. .vue, .js-Dateien, die dieselbe Konfigurationsdatei aufweisen

import { findReference } from '@sumor/config'

const config = await findReference(process.cwd(), ['vue', 'js'])
// Lädt alle *.entity.yml oder *.entity.json, die denselben Namen wie *.vue oder *.js im Root-Verzeichnis haben
/*
 * Beispiel:
 *   car.entity.yml, bike.entity.json
 *   car.vue, bike.js
 *   {
 *       "car": {...}
 *       "bike": {...}
 *   }
 * */