Configuration

Configs API (Singleton)

Type-safe, global configuration manager that solves initialization timing issues in modular structures.

Thread Safety

The Configs API is isolated per process, ensuring stability in Cluster mode and worker-node environments.

Basic Usage

Instead of accessing app.configs directly, use the Configs singleton for safe, modular access anywhere in your code.

typescript

import { Configs } from "xypriss";

// Get configuration (type-safe)
const fileUpload = Configs.get("fileUpload");

// Get with default fallback
const serverPort = Configs.getOrDefault("server", { port: 8080 }).port;

// Check if a section exists
if (Configs.has("security")) {
    /* logic */
}

Modifying Configuration

Update or merge settings dynamically during runtime.

typescript

// Deep merge partial updates
Configs.merge({
    fileUpload: { maxFileSize: 50 * 1024 * 1024 }
});

// Update specific section
Configs.update("logging", { level: "debug" });

Available Keys

env

cache

performance

monitoring

server

multiServer

requestManagement

fileUpload

security

cluster

logging

middleware

Multi-Server Setup

Configure distributed architectures with dedicated worker nodes and primary controllers.