Class ConfigManager

constructor

• new ConfigManager(logger?: SoloLogger): ConfigManager

• Parameters

  • Optionallogger: SoloLogger

  Returns ConfigManager

config

applyPrecedence

• applyPrecedence(argv: Argv<any>, aliases: any): Argv<any>

• Apply the command flags precedence

  It uses the below precedence for command flag values:

  1. User input of the command flag
  2. Default value of the command flag if the command is not 'init'.

  Parameters

  • argv: Argv<any>
  • aliases: any

  Returns Argv<any>

executePrompt

• executePrompt(
      task: TaskWrapper<any, any, any>,
      flagList?: CommandFlag[],
  ): Promise<void>

• Run prompts for the given set of flags

  Parameters

  • task: TaskWrapper<any, any, any>

    task object from listr2
  • flagList: CommandFlag[] = []

    list of flag objects

  Returns Promise<void>

getFlag

• getFlag<T>(flag: CommandFlag): T

• Return the value of the given flag

  Type Parameters

  • T

  Parameters

  • flag: CommandFlag

  Returns T

  value of the flag or undefined if flag value is not available

getVersion

• getVersion(): string

• Get package version

  Returns string

hasFlag

• hasFlag(flag: CommandFlag): boolean

• Check if a flag value is set

  Parameters

  • flag: CommandFlag

  Returns boolean

reset

• reset(): void

• Reset config

  Returns void

setFlag

• setFlag<T>(flag: CommandFlag, value: T): void

• Set value for the flag

  Type Parameters

  • T

  Parameters

  • flag: CommandFlag
  • value: T

  Returns void

update

• update(argv?: any): void

• Update the config using the argv

  Parameters

  • argv: any = {}

  Returns void