Class RamlUtil

Class which holds helper tools when working with ramls.

export
class: RamlUtil

Hierarchy

RamlUtil

Index

Methods

Methods

generateFakeData

generateFakeData(field: string, type: string, values?: string[]): string | number | boolean

- Defined in commons/utils/ramlUtil.ts:21
Generate fake data for a field name

Parameters
- field: string
  
  field name
- type: string
  
  data raml type: can be number / string / Boolean / date etc
- Optional values: string[]
  
  default values for attributes (eg. enum: 'Yes' | 'No')
Returns string | number | boolean

fake data

generateId

generateId(type: string): number | string

- Defined in commons/utils/ramlUtil.ts:71
Generate id/_id field value

Parameters
- type: string
  
  can be number / string / boolean
Returns number | string

random id

parseRamlValue

parseRamlValue(value: string, type: string): number | string | boolean

- Defined in commons/utils/ramlUtil.ts:52
Parse object value to a custom raml type

Parameters
- value: string
  
  value to be parsed
- type: string
  
  raml type
Returns number | string | boolean

parsed value

Generated using TypeDoc