Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContainerConfigReader

Helper class that reads container configuration from JSON or YAML file.

Hierarchy

  • ContainerConfigReader

Index

Methods

Methods

Static readFromFile

  • readFromFile(correlationId: string, path: string, parameters: ConfigParams): ContainerConfig

  • Reads container configuration from JSON or YAML file. The type of the file is determined by file extension.

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • path: string

      a path to component configuration file.

    • parameters: ConfigParams

      values to parameters the configuration or null to skip parameterization.

    Returns ContainerConfig

    the read container configuration

Static readFromJsonFile

  • readFromJsonFile(correlationId: string, path: string, parameters: ConfigParams): ContainerConfig

  • Reads container configuration from JSON file.

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • path: string

      a path to component configuration file.

    • parameters: ConfigParams

      values to parameters the configuration or null to skip parameterization.

    Returns ContainerConfig

    the read container configuration

Static readFromYamlFile

  • readFromYamlFile(correlationId: string, path: string, parameters: ConfigParams): ContainerConfig

  • Reads container configuration from YAML file.

    Parameters

    • correlationId: string

      (optional) transaction id to trace execution through call chain.

    • path: string

      a path to component configuration file.

    • parameters: ConfigParams

      values to parameters the configuration or null to skip parameterization.

    Returns ContainerConfig

    the read container configuration

Generated using TypeDoc