Class SemicolonConfigParser<Out, RawType>

constructor

• new SemicolonConfigParser<
      Out extends OutConfigParseType = OutConfigParseType,
      RawType extends RawConfigParseType = RawConfigParseType,
  >(
      __namedParameters?: SemicolonConfigParserOptions<
          Out,
          RawConfigParseType,
      >,
  ): SemicolonConfigParser<Out, RawType>

• Type Parameters

  • Out extends OutConfigParseType = OutConfigParseType
  • RawType extends RawConfigParseType = RawConfigParseType

  Parameters

  • __namedParameters: SemicolonConfigParserOptions<Out, RawConfigParseType> = {}

  Returns SemicolonConfigParser<Out, RawType>

name

parse

• parse(__namedParameters: ParserProps): Promise<RawType>

• Config parser function

  Parameters

  • __namedParameters: ParserProps

  Returns Promise<RawType>

  Throws

  Error if parsing fails

postValidate

• postValidate(
      __namedParameters: PostValidateProps<RawType>,
  ): Promise<undefined | Out>

• Optional value validation after parsing

  Parameters

  • __namedParameters: PostValidateProps<RawType>

  Returns Promise<undefined | Out>

  Throws

  Error if validation fails

toLogString

• toLogString(value: Out): string

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

  Parameters

  • value: Out

    value to log

  Returns string

toString

• toString(value: Out, options?: EncodeOptions): string

• Build readable string from value

  Parameters

  • value: Out
  • Optionaloptions: EncodeOptions

  Returns string