Class RamlFileOperations

Class which implements the logic for implementing raml generation file related actions.

export
class: RamlFileOperations

Hierarchy

RamlFileOperations

Index

Constructors

constructor

Properties

filePath

Methods

Constructors

constructor

new RamlFileOperations(filePath: string): RamlFileOperations

- Defined in fileOperations/RamlFileOperations.ts:25
Parameters
- filePath: string
Returns RamlFileOperations

Properties

Private filePath

filePath: string

Path to the folder where the raml will be generated.

type: {string}
memberof: ApiFileOperations

Methods

createDirectoryStructure

createDirectoryStructure(): Promise<boolean[]>

- Defined in fileOperations/RamlFileOperations.ts:35
Create directory structure for the application

Returns Promise<boolean[]>

created directory structure.

generateSchemaApiFiles

generateSchemaApiFiles(schema: Schema, options: RAMLApplicationInfo): Promise<boolean>

- Defined in fileOperations/RamlFileOperations.ts:86
Generate api.raml spec for the whole api.

Parameters
- schema: Schema
  
  database schema
- options: RAMLApplicationInfo
  
  application info
Returns Promise<boolean>
- true if spec generated

generateSchemaExampleFiles

generateSchemaExampleFiles(schema: Schema): Promise<boolean[]>

- Defined in fileOperations/RamlFileOperations.ts:99
Generate .json entity for every table from schema. File will be saved on path: ./raml/types/entityName.json

Parameters
- schema: Schema
  
  schema containing tables.
Returns Promise<boolean[]>

generated examle files.

generateSchemaExamplesFilesFromCache

generateSchemaExamplesFilesFromCache(): Promise<boolean[]>

- Defined in fileOperations/RamlFileOperations.ts:128
Generate .json Array entity for every array of objects saved in cache

Returns Promise<boolean[]>

generated example files.

generateSchemaTypeFiles

generateSchemaTypeFiles(schema: Schema): Promise<boolean[]>

- Defined in fileOperations/RamlFileOperations.ts:60
Create .raml type file for every table inside schema

Parameters
- schema: Schema
  
  schema tables(list of tables)
Returns Promise<boolean[]>

generated type files.

getFilePath

getFilePath(): string

- Defined in fileOperations/RamlFileOperations.ts:159
Returns file path.

Returns string

file path

Generated using TypeDoc