@contextjs/configuration-json

   

JSON-based configuration provider for ContextJS applications.

Features

• Plug-and-play JSON configuration support
• Supports environment-specific configuration files
• Fully integrated with @contextjs/configuration
• Simple fluent API for loading files

Installation

npm i @contextjs/configuration-json

Quick Start

Example json configuration file appsettings.json:

{
  "App": {
    "Port": 3000,
    "Name": "My Application"
  }
}

Code:

import "@contextjs/configuration";
import "@contextjs/configuration-json";

import { Application, EnvironmentName } from "@contextjs/system";

const application = new Application();

application.useConfiguration(options => {
    options.useJsonConfiguration(json => {
        json.useFile("filepath/appsettings.json");
        json.useFile("filepath/appsettings.development.json", "development");
        json.useFile("filepath/appsettings.production.json", "production");
    });
});
application.environment.name = EnvironmentName.production;

const port = await application.configuration.getValueAsync("App:Port");
console.log(`Starting server on port ${port}...`);

API Reference

/**
 * Extends ConfigurationOptions with support for JSON-based configuration.
 */
declare module "@contextjs/configuration" {
    export interface ConfigurationOptions {
        /**
         * Adds a JSON configuration provider to the application.
         *
         * @param options A callback to configure JSON file sources.
         * @returns The current ConfigurationOptions instance.
         */
        useJsonConfiguration(options: (configurationOptions: JsonConfigurationOptions) => void): ConfigurationOptions;
    }
}

/**
 * Provides options for configuring JSON-based configuration sources.
 */
export declare class JsonConfigurationOptions {
    /**
     * Registers a JSON file as a configuration source.
     *
     * @param file The path to the configuration file.
     * @returns The current JsonConfigurationOptions instance.
     */
    public useFile(file: string): JsonConfigurationOptions;

    /**
     * Registers a JSON file for a specific environment.
     *
     * @param file The path to the configuration file.
     * @param environmentName The target environment name (e.g., "development").
     * @returns The current JsonConfigurationOptions instance.
     */
    public useFile(file: string, environmentName: string): JsonConfigurationOptions;
}