@djleehaha/config v0.0.6

Config

Description

This is a convenience module bring together many config file formats including:

• jsonc
• json5
• hjson
• toml
• yaml
• ini

To install the module, use npm:

npm install @djleehaha/config

Usage

import Config from 'config';

const config = Config.parse('json', FS.readFileSync(`config.json`, 'utf8'));
// or
const config = Config.loadConfig({
    "config.json": "json",
    "config.yaml": "yaml",
});

API

Config.parse(format, content)

Parses the content as the given format

Parameters:

• format (string): One of the supported file format.
• content (string): Content of the config (not the filename)

Returns: Parsed content of the supplied config

Example:

const config = Config.parse('json', `{"some": "json"}`);

Config.loadConfig(files)

Checks if any of the files in the files object exist and attempts to load them in the corresponding format

Parameters:

• files (object): An object, the keys of which are filenames (optionally including paths) to check for. The value is the format to parse the file as.

Returns: Parsed content of config file if found.

Example:

const config = Config.loadConfig({ "config.json": "json", "config.yaml": "yaml"});

Config.loadConfigAsync(files)

Checks if any of the files in the files object exist and attempts to load them in the corresponding format.

Parameters:

• files (object): An object, the keys of which are filenames (optionally including paths) to check for. The value is the format to parse the file as.

Returns: Promise: Parsed content of config file if found.

Example:

const config = await Config.loadConfigAsync({ "config.json": "json", "config.yaml": "yaml"});

Contributing

If you think there is another format that this module support, please do create a pull request

License

This project is licensed under the MIT License.

Acknowledgements

typescript

Directly uses the following npm modules:

• hjson
• ini
• json5
• jsonc
• smol-toml
• yaml