Class RamlHandler

Raml Handler.

export
class: RamlHandler
extends: {BaseHandler}

Hierarchy

BaseHandler
- RamlHandler

Index

Constructors

constructor

Properties

path

Methods

Constructors

constructor

new RamlHandler(options: object): RamlHandler

Overrides BaseHandler.constructor
- Defined in handlers/RamlHandler.ts:21
Constructor for the RamlHandler.

Parameters
- options: object
  
  Spec path.
  - path: string
Returns RamlHandler

Properties

Private path

path: string

Path of raml spec.

type: {string}
memberof: RamlHandler

Methods

normalizeColumnSchema

normalizeColumnSchema(columnSchema: RamlColumnSchema | MySqlColumnSchema): Column

Inherited from BaseHandler.normalizeColumnSchema
- Defined in handlers/BaseHandler.ts:32
Normalize column schema.

Parameters
- columnSchema: RamlColumnSchema | MySqlColumnSchema
  
  sql column schema
Returns Column

normalized column schema

normalizeRelations

normalizeRelations(schema: Schema): Schema

Inherited from BaseHandler.normalizeRelations
- Defined in handlers/BaseHandler.ts:52
Normalize relations between tables inside the schema.

Parameters
- schema: Schema
  
  database schema
Returns Schema

normalized database schema

parseSchema

parseSchema(): Promise<Schema>

- Defined in handlers/RamlHandler.ts:38
Parse raml spec file and return a normalized schema.

memberof

RamlHandler

Returns Promise<Schema>

parsed schema.

Generated using TypeDoc