Class FormatHelpers

Constructors

constructor

Properties

toConstantCase toParamCase toPascalCase toSnakeCase

Methods

breakLines getIndentation indent lowerFirst renderJSONExamples replaceSpecialCharacters snakeCase toCamelCase toPascalCaseMergingNumbers upperFirst

Constructors

constructor

Properties

Static toConstantCase

toConstantCase: ((input, options?) => string) = constantCase

Transform into upper case string with an underscore between words.

Type declaration

    • (input, options?): string

    • Parameters

      • input: string
      • Optional options: Options

      Returns string

Returns

Static toParamCase

toParamCase: ((input, options?) => string) = paramCase

Transform into a lower cased string with dashes between words.

Type declaration

    • (input, options?): string

    • Parameters

      • input: string
      • Optional options: Options

      Returns string

Returns

Static toPascalCase

toPascalCase: ((input, options?) => string) = pascalCase

Transform into a string of capitalized words without separators.

Type declaration

    • (input, options?): string

    • Parameters

      • input: string
      • Optional options: Options

      Returns string

Returns

Static toSnakeCase

toSnakeCase: ((input, options?) => string) = snakeCase

Transform into lower case string with an underscore between words.

Type declaration

    • (input, options?): string

    • Parameters

      • input: string
      • Optional options: Options

      Returns string

Returns

Methods

Static breakLines

  • breakLines(lines): string[]

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

    Parameters

    • lines: string | string[]

      to breaks

    Returns string[]

Static Private getIndentation

  • getIndentation(size?, type?): string
  • Private

    Get the indentation string based on how many and which type of indentation are requested.

    Parameters

    • size: number = 0

      the number of indentations to use

    • type: IndentationTypes = IndentationTypes.SPACES

      the type of indentations to use. SPACES by default.

    Returns string

Static indent

  • indent(content?, size?, type?): 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

Static lowerFirst

Static renderJSONExamples

  • renderJSONExamples(examples): string

  • Render given JSON Schema example to string

    Parameters

    • examples: any[]

      to render

    Returns string

Static replaceSpecialCharacters

  • replaceSpecialCharacters(string, options?): string

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

    Parameters

    • string: string
    • Optional options: ReplaceSpecialCharactersOptions

    Returns string

Static snakeCase

Static toCamelCase

  • toCamelCase(renderName): string

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

    Parameters

    • renderName: string

    Returns string

Static toPascalCaseMergingNumbers

  • toPascalCaseMergingNumbers(value): string

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

    Parameters

    • value: string

      to transform

    Returns string

Static upperFirst

Settings

Member Visibility

Theme

On This Page

constructortoConstantCasetoParamCasetoPascalCasetoSnakeCasebreakLinesgetIndentationindentlowerFirstrenderJSONExamplesreplaceSpecialCharacterssnakeCasetoCamelCasetoPascalCaseMergingNumbersupperFirst