Class FormatHelpers

constructor

• new FormatHelpers(): FormatHelpers

  Returns FormatHelpers

StatictoConstantCase

StatictoParamCase

StatictoPascalCase

StatictoSnakeCase

StaticbreakLines

• breakLines(lines: string | string[]): string[]

  Ensures breaking text into new lines according to newline char (\n) in text.

  Parameters

  • lines: string | string[]

    to breaks

  Returns string[]

Staticindent

• indent(content?: string, size?: number, type?: IndentationTypes): string

  Ensures indentations are prepended to content.

  Parameters

  • content: string = ''

    to prepend the indentation.

  • size: number = 1

    the number of indentations to use. 1 by default

  • type: IndentationTypes = IndentationTypes.SPACES

    the type of indentations to use. SPACES by default.

  Returns string

StaticlowerFirst

• lowerFirst(value: string): string

  Lower first char in given string value.

  Parameters

  • value: string

    to change

  Returns string

StaticrenderJSONExamples

• renderJSONExamples(examples: any[]): string

  Render given JSON Schema example to string

  Parameters

  • examples: any[]

    to render

  Returns string

StaticreplaceSpecialCharacters

• replaceSpecialCharacters(
      string: string,
      options?: ReplaceSpecialCharactersOptions,
  ): string

  Replace special characters (Not 0-9,a-z,A-Z) with character names

  Parameters

  • string: string
  • Optionaloptions: ReplaceSpecialCharactersOptions

  Returns string

StaticsnakeCase

• snakeCase(renderName: string): string

  Parameters

  • renderName: string

  Returns string

StatictoCamelCase

• toCamelCase(renderName: string): string

  Transform into a string with the separator denoted by the next word capitalized.

  Parameters

  • renderName: string

  Returns string

StatictoPascalCaseMergingNumbers

• toPascalCaseMergingNumbers(value: string): string

  Transform into a string of capitalized words without separators merging numbers.

  Parameters

  • value: string

    to transform

  Returns string

StaticupperFirst

• upperFirst(value: string): string

  Upper first char in given string value.

  Parameters

  • value: string

    to change

  Returns string