Class JsonConfigParser<Out>

constructor

• new JsonConfigParser<Out extends JsonParseType>(
      __namedParameters?: {
          keysToHide?: (keyof Out)[];
          showValue?: ShowValueType;
          validate?: ValidateCallback<Out, JsonParseType>;
      },
  ): JsonConfigParser<Out>

• Type Parameters

  • Out extends JsonParseType

  Parameters

  • __namedParameters: {
        keysToHide?: (keyof Out)[];
        showValue?: ShowValueType;
        validate?: ValidateCallback<Out, JsonParseType>;
    } = {}

  Returns JsonConfigParser<Out>

name

parse

• parse(__namedParameters: ParserProps): JsonParseType

• Config parser function

  Parameters

  • __namedParameters: ParserProps

  Returns JsonParseType

  Throws

  Error if parsing fails

postValidate

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

• Optional value validation after parsing

  Parameters

  • __namedParameters: PostValidateProps<JsonParseType>

  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): string

• Build readable string from value

  Parameters

  • value: Out

  Returns string