Interface IConfigParser<Input, Output>

name

parse

• parse(parserProps: ParserProps): Input | Promise<Input>

  Config parser function

  Parameters

  • parserProps: ParserProps

  Returns Input | Promise<Input>

  Throws

  Error if parsing fails

OptionalpostValidate

• postValidate(
      postValidateProps: PostValidateProps<Input>,
  ): undefined | Output | Promise<undefined | Output>

  Optional value validation after parsing

  Parameters

  • postValidateProps: PostValidateProps<Input>

  Returns undefined | Output | Promise<undefined | Output>

  Throws

  Error if validation fails

OptionalpreValidate

• preValidate(preValidateProps: PreValidateProps): void | Promise<void>

  Optional raw string value validation before parsing.

  Parameters

  • preValidateProps: PreValidateProps

  Returns void | Promise<void>

  Throws

  Error if validation fails

OptionaltoLogString

• toLogString(config: Output): string

  Optional build readable string from value for log (can hide sensitive part from logs) else toString is used

  Parameters

  • config: Output

    value to log

  Returns string

toString

• toString(config: Output, options?: EncodeOptions): string

  Build readable string from value

  Parameters

  • config: Output
  • Optionaloptions: EncodeOptions

  Returns string