hassanzohdy/mongez-config/listing

Listing — config.list

config.list(): Record<string, any>

Returns the entire data object by reference. Useful for:

• Debugging at boot (console.log(config.list())).
• Serializing for a snapshot.
• Wholesale replacement via Object.assign.

Live reference

The returned object is the same one set mutates. Mutating it mutates the live config:

config.set({ a: 1 });
const tree = config.list();
tree.a = 999;
config.get("a");                             // 999

This is fast but easy to misuse. If you want an independent snapshot, clone explicitly:

const snapshot = structuredClone(config.list());
// or
const snapshot = JSON.parse(JSON.stringify(config.list()));

structuredClone handles Date, Map, Set, typed arrays, and circular refs; JSON round-tripping is faster but drops anything non-JSON-serializable.

Empty by default

import config from "@mongez/config";
config.list();                               // {}

The config tree starts as a plain empty object on every fresh module load.

Don't remove keys by mutating this object. list() returning the live tree is an implementation detail, not a contract. Use config.unset(key) (or config.set(key, undefined)) — added in 1.2.0 precisely so callers never have to reach in here.

Patterns

Boot-time debug dump

if (process.env.DEBUG_CONFIG) {
  console.log("[config]", config.list());
}

Serialize for a CLI tool

import fs from "node:fs";
import config from "@mongez/config";
config.set(myAppConfig);
fs.writeFileSync("config-snapshot.json", JSON.stringify(config.list(), null, 2));

Replace the entire tree wholesale (escape hatch)

There's no config.replace(...) API. If you really need to wipe and reload:

import config from "@mongez/config";
const data = config.list();
for (const key of Object.keys(data)) {
  delete (data as any)[key];
}
config.set(newConfig);

This is rarely the right move — prefer additive set calls that overwrite the keys you care about.