Node Konfig

Thanks to Konfig for the inspiration. This library would not have been possible without it.

Documentation is available at https://willsoto.github.io/node-konfig/

Installation

1npm install @willsoto/node-konfig-core

1yarn add @willsoto/node-konfig-core

1pnpm add @willsoto/node-konfig-core

Quick look

1// configs/development.json
2{
3  "name": "my-app",
4  "database": {
5    "host": "localhost",
6    "port": 5432
7  }
8}

1import * as Konfig from "@willsoto/node-konfig-core";
2import path from "node:path";
3
4// Create the store, this is the object you will use to access your config
5export const store = new Konfig.Store();
6
7// This will load configuration from the specified files. A parser must be provided
8// so the loader knows how to interpret the file.
9// Files are loaded in order, so any conflicts will be resolved through a "last one wins" approach.
10// In this case, `local.json` will override properties that exist in both configurations.
11const loader = new Konfig.FileLoader({
12  files: [
13    {
14      path: path.join(process.cwd(), "configs", "development.json"),
15      // This will tell the loader how it should interpret the files it loads
16      parser: parser,
17    },
18    {
19      path: path.join(process.cwd(), "configs", "local.json"),
20      // This will tell the loader how it should interpret the files it loads
21      parser: parser,
22    },
23  ],
24});
25
26// Make sure the loader is registered on the store in order for it to be processed.
27store.registerLoader(loader);
28
29// `init` must be called in order to actually resolve and process all the registered loaders
30// This only needs to be called once at some point during application startup.
31await store.init();
32
33const databaseConfig = store.get("database");
34
35console.log(databaseConfig);
36// {
37//   "host": "localhost",
38//   "port": 5432
39// }