Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigManager

Manages Lamington configuration setup and caching

Hierarchy

  • ConfigManager

Index

Accessors

Static cdt

  • get cdt(): string
  • Returns the current EOSIO.CDT configuration

    author

    Kevin Brown <github.com/thekevinbrown>

    Returns string

Static contracts

  • get contracts(): string
  • Returns the current eosio.contracts configuration

    author

    Johan Nordberg <github.com/jnordberg>

    Returns string

Static debugTransactions

  • get debugTransactions(): boolean
  • Returns the container's debug log output setting

    author

    Kevin Brown <github.com/thekevinbrown>

    Returns boolean

Static eos

  • get eos(): string
  • Returns the current EOSIO configuration

    author

    Kevin Brown <github.com/thekevinbrown>

    Returns string

Static exclude

  • get exclude(): string[]
  • Returns the array of excluded strings or patterns

    author

    Mitch Pierias <github.com/MitchPierias>

    Returns string[]

Static keepAlive

  • get keepAlive(): boolean
  • Returns the container keep alive setting or false

    author

    Mitch Pierias <github.com/MitchPierias>

    Returns boolean

Static outDir

  • get outDir(): string
  • Returns the output build directory or [[CACHE_DIRECTORY]]

    author

    Mitch Pierias <github.com/MitchPierias>

    Returns string

Static testReporter

  • get testReporter(): string | Min
  • Returns the array of excluded strings or patterns

    author

    Dallas Johnson <github.com/dallasjohnson>

    Returns string | Min

Methods

Static configExists

  • configExists(atPath?: string): Promise<boolean>
  • Checks the existence of the configuration file at the default [[CONFIGURATION_FILE_NAME]] or optional path

    author

    Mitch Pierias <github.com/MitchPierias>

    Parameters

    • Default value atPath: string = CONFIGURATION_FILE_NAME

      Optional file path for lookup

    Returns Promise<boolean>

    Config exists determiner

Static createConfigIfMissing

  • createConfigIfMissing(atPath?: string): Promise<void>
  • Creates a default configuration file if it doesn't exist at the specified path.

    author

    Mitch Pierias <github.com/MitchPierias>

    author

    Kevin Brown <github.com/thekevinbrown>

    Parameters

    • Default value atPath: string = CONFIGURATION_FILE_NAME

      Optional configuration file path. Defaults to .lamingtonrc.

    Returns Promise<void>

Static initWithDefaults

  • initWithDefaults(): Promise<void>
  • Initialize application configuration using the user defined configurations and defaults

    author

    Kevin Brown <github.com/thekevinbrown>

    author

    Mitch Pierias <github.com/MitchPierias>

    Returns Promise<void>

Static isValidConfig

  • isValidConfig(config: object): Promise<boolean>
  • Parameters

    • config: object

    Returns Promise<boolean>

Static loadConfigFromDisk

  • loadConfigFromDisk(atPath?: string): Promise<void>
  • Loads an existing configuration file into [[ConfigManager.config]]

    author

    Kevin Brown <github.com/thekevinbrown>

    Parameters

    • Default value atPath: string = CONFIGURATION_FILE_NAME

      Optional file path for lookup

    Returns Promise<void>

Generated using TypeDoc