Class ExamplesGenerator

Class which holds the logic for generating example data.

export
class: ExamplesGenerator

Hierarchy

ExamplesGenerator

Index

Properties

Methods

generateTypeExampleContent

Properties

PRIME_KEY

PRIME_KEY: string = "raml"

Key used in storing and searching for cached elements.

type: {string}
memberof: ExamplesGenerator

Private defaultRamlTypes

defaultRamlTypes: string[] = ['number', 'boolean', 'string', 'date-only', 'datetime','time-only', 'datetime-only', 'file', 'nil', 'union', 'enum',]

Array of default raml types supported.

type: {string[]}
memberof: ExamplesGenerator

Methods

generateTypeExampleContent

generateTypeExampleContent(schema: Schema, table: Table, depthLevel: number): Example

- Defined in generators/spec/examples.ts:45
Generate type example for a certain table

Parameters
- schema: Schema
  
  entire collection of tables
- table: Table
  
  table information
- depthLevel: number
  
  columns depth level to be computed
Returns Example

object containing - type name(with titleCase)
```
                                  - table content object to be stringified
```

Generated using TypeDoc