Class FormatHelpers

Hierarchy

FormatHelpers

Index

Constructors

Properties

toCamelCase toConstantCase toParamCase toPascalCase toSnakeCase

Methods

breakLines getIndentation indent lowerFirst renderJSONExamples replaceSpecialCharacters snakeCase toPascalCaseMergingNumbers upperFirst

Constructors

constructor

new FormatHelpers(): FormatHelpers
Returns FormatHelpers

Properties

`Static` toCamelCase

toCamelCase: ((input, options?) => string) = camelCase

Type declaration

- (input, options?): string
- Transform into a string with the separator denoted by the next word capitalized.
  Parameters
  - input: string
  - Optional options: Options
  Returns string

`Static` toConstantCase

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

Type declaration

- (input, options?): string
- Transform into upper case string with an underscore between words.
  Parameters
  - input: string
  - Optional options: Options
  Returns string

`Static` toParamCase

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

Type declaration

- (input, options?): string
- Transform into a lower cased string with dashes between words.
  Parameters
  - input: string
  - Optional options: Options
  Returns string

`Static` toPascalCase

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

Type declaration

- (input, options?): string
- Transform into a string of capitalized words without separators.
  Parameters
  - input: string
  - Optional options: Options
  Returns string

`Static` toSnakeCase

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

Type declaration

- (input, options?): string
- Transform into lower case string with an underscore between words.
  Parameters
  - input: string
  - Optional options: Options
  Returns string

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[]
- Defined in src/helpers/FormatHelpers.ts:153

`Static` `Private` getIndentation

getIndentation(size?, type?): string
Private
Get the indendation string based on how many and which type of indentation are requested.
Parameters
- size: number = 0
  
  the number of indendations to use
- type: IndentationTypes = IndentationTypes.SPACES
  
  the type of indendations to use. SPACES by default.
Returns string
- Defined in src/helpers/FormatHelpers.ts:195

`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 indendations to use. 1 by default
- type: IndentationTypes = IndentationTypes.SPACES
  
  the type of indendations to use. SPACES by default.
Returns string
- Defined in src/helpers/FormatHelpers.ts:165

`Static` lowerFirst

lowerFirst(value): string
Lower first char in given string value.
Parameters
- value: string
  
  to change
Returns string
- Defined in src/helpers/FormatHelpers.ts:71

`Static` renderJSONExamples

renderJSONExamples(examples): string
Render given JSON Schema example to string
Parameters
- examples: any[]
  
  to render
Returns string
- Defined in src/helpers/FormatHelpers.ts:209

`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
- Defined in src/helpers/FormatHelpers.ts:126

`Static` snakeCase

snakeCase(renderName): string
Parameters
- renderName: string
Returns string
- Defined in src/helpers/FormatHelpers.ts:230

`Static` toPascalCaseMergingNumbers

toPascalCaseMergingNumbers(value): string
Transform into a string of capitalized words without separators merging numbers.
Parameters
- value: string
  
  to transform
Returns string
- Defined in src/helpers/FormatHelpers.ts:95

`Static` upperFirst

upperFirst(value): string
Upper first char in given string value.
Parameters
- value: string
  
  to change
Returns string
- Defined in src/helpers/FormatHelpers.ts:62

Generated using TypeDoc