Class ApiAction

Hierarchy

ApiAction

Index

Constructors

Properties

category controllerClassName controllerPath description deserializedMethodType? groups methodName methodType parameterSignature returnSignature

Accessors

Methods

getMethodType getParametersType getResultsType

Constructors

constructor

new ApiAction(controllerClassName: string, controllerPath: string, methodName: string, description: string, groups: string[], category: string): ApiAction
Parameters
- controllerClassName: string
- controllerPath: string
- methodName: string
- description: string
- groups: string[]
- category: string
Returns ApiAction
- Defined in packages/api-console-api/src/api.ts:46

Properties

category

category: string

controllerClassName

controllerClassName: string

controllerPath

controllerPath: string

description

description: string

`Protected` `Optional` deserializedMethodType

deserializedMethodType?: TypeMethod & Excluded<"*">

Reflection

never

groups

groups: string[]

methodName

methodName: string

methodType

methodType: any

parameterSignature

parameterSignature: string = ''

returnSignature

returnSignature: string = ''

Accessors

id

get id(): string
Reflection
never

Returns string
- Defined in packages/api-console-api/src/api.ts:74

Methods

getMethodType

getMethodType(): TypeMethod
Returns TypeMethod
- Defined in packages/api-console-api/src/api.ts:56

getParametersType

getParametersType(): TypeParameter[]
Reflection
never

Returns TypeParameter[]
- Defined in packages/api-console-api/src/api.ts:64

getResultsType

getResultsType(): undefined | Type
Reflection
never

Returns undefined | Type
- Defined in packages/api-console-api/src/api.ts:69

Generated using TypeDoc