JsonConfigReader

Config reader that reads a configuration from a JSON file.

Extends: FileConfigReader

Description

The JsonConfigReader class allows you to create a config reader that reads a configuration from a JSON file.

Important points

  • The reader supports parameterization using Handlebar template engine.

Configuration parameters

  • path: path to the configuration file
  • parameters: this entire section is used as template parameters
  • …

Constructors

Creates a new instance of the config reader.

public constructor(path: string = null)

  • path: string - (optional) path to the configuration file.

Instance methods

readConfig

Reads a configuration and parameterizes it with given values.

public readConfig(correlationId: string, parameters: ConfigParams): Promise<ConfigParams>

  • correlationId: string - (optional) transaction id to trace execution through call chain.
  • parameters: ConfigParams - values to parameters the configuration or null to skip parameterization.
  • returns: Promise<ConfigParams> - ConfigParams configuration.

readObject

Reads a configuration file, parameterizes its content and converts it into a JSON object.

public readObject(correlationId: string, parameters: ConfigParams): any

  • correlationId: string - (optional) transaction id to trace execution through a call chain.
  • parameters: ConfigParams - values of the configuration parameters.
  • returns: any - a JSON object with configuration.

Static methods

readConfig

Reads a configuration from a file, parameterizes it with given values and returns a new ConfigParams object.

public static readConfig(correlationId: string, path: string, parameters: ConfigParams): ConfigParams

  • correlationId: string - (optional) transaction id used to trace execution through a call chain.
  • path: string - a path to configuration file.
  • parameters: ConfigParams - values of the configuration parameters.
  • returns: ConfigParams - ConfigParams configuration.

readObject

Reads a configuration file, parameterizes its content and converts it into a JSON object.

public static readObject(correlationId: string, path: string, parameters: ConfigParams): any

  • correlationId: string - (optional) transaction id to trace execution through a call chain.
  • path: string - a path to configuration file.
  • parameters: ConfigParams - values of the configuration parameters.
  • returns: any - a JSON object with configuration.

Examples

{ "key1": "{{KEY1_VALUE}}", "key2": "{{KEY2_VALUE}}" }

let configReader = new JsonConfigReader("config.json");
  
let parameters = ConfigParams.fromTuples("KEY1_VALUE", 123, "KEY2_VALUE", "ABC");
let config = await configReader.readConfig("123", parameters);
// Result: key1=123;key2=ABC

See also