Class ApiDocContext

Hierarchy

ApiDocContext

Index

Properties

KeyPathError

Methods

Properties

Static KeyPathError

KeyPathError: KeyPathError = KeyPathError

Methods

Static generateBlueprintDocument

generateBlueprintDocument(params: object): string

- Defined in util/apidoccontext.ts:165
Parameters
- params: object
  - docs: ApiDoc[]
  - host: string
Returns string

Static generateMonitorConfig

generateMonitorConfig(params: object): void

- Defined in util/apidoccontext.ts:31
Parameters
- params: object
  - appId: number
  - Optional createdAt?: Date
  - docs: ApiDoc[]
  - host: string
  - outputFilePath: string
  - timeInterval: number
  - Optional version?: number
Returns void

Static generateMonitorConfigObject

generateMonitorConfigObject(params: object): ProjectApiDescription

- Defined in util/apidoccontext.ts:39
Parameters
- params: object
  - appId: number
  - Optional createdAt?: Date
  - docs: ApiDoc[]
  - host: string
  - timeInterval: number
  - Optional version?: number
Returns ProjectApiDescription

Static generateUnitTestString

generateUnitTestString(params: object): string

- Defined in util/apidoccontext.ts:63
Parameters
- params: object
  - doc: ApiDoc
  - Optional host?: string
Returns string

Static generateUnitTests

generateUnitTests(params: object): void

- Defined in util/apidoccontext.ts:53
Parameters
- params: object
  - docs: ApiDoc[]
  - Optional host?: string
  - path: string
Returns void