Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DotEnvConfig Abstract

The default process.env configuration loader for Tapjaw Importer.

Hierarchy-Diagram

UML class diagram of DotEnvConfig

Legend

icon for a class in the UML class diagram class
icon for an abstract class in the UML class diagram abstract class
icon for a protected property in the UML class diagram protected property
icon for a public method in the UML class diagram public method
icon for a private method in the UML class diagram private method

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DotEnvConfig(configName: string, configNamespaceKey: string): DotEnvConfig

  • Parameters

    • configName: string

      string Custom name for the config loader class.

    • configNamespaceKey: string

      string The namespace key which this class should load. For example APP_ will import all configurations values starting with key `APP_*.

    Returns DotEnvConfig

Properties

Protected Readonly config

config: ConfigurationMap = ...

Methods

getConfig

  • getConfig(configKey: string): string

  • Get a configuration value from the available configurations in this classes namespace.

    throws

    TapjawConfigError

    Parameters

    • configKey: string

      string The configuration key minus the this.configNamespaceKey. For example APP_NAME would be requested with this.getConfig('NAME');.

    Returns string

    string | never

Private initialiseConfig

  • initialiseConfig(jobsEnvKey: string): void

  • Register a configuration name and value into this configuration instance.

    Parameters

    • jobsEnvKey: string

      string The fullname of the configuration key to registered.

    Returns void

Generated using TypeDoc