Class ApiVersionAction

Hierarchy (View Summary)

RouteApiAction
- ApiVersionAction

Index

Constructors

Properties

channel exmod forceDebug logger mode requestSchema type

Methods

bodyValidation debug error getCClient getConfigStore getKernel getModule getName handler info lError log register secureHandler setLogger setMode verbose warn sendError validateSchema

Constructors

constructor

new ApiVersionAction(
module: IBaseKernelModule<IKernel<JwtExtend>, any, any, any, any>,
extMod?: IBaseKernelModule<IKernel<JwtExtend>>,
): ApiVersionAction
Parameters
- module: IBaseKernelModule<IKernel<JwtExtend>, any, any, any, any>
- OptionalextMod: IBaseKernelModule<IKernel<JwtExtend>>
Returns ApiVersionAction
Inherited from RouteApiAction.constructor
- Defined in src/classes/RouteApiAction.ts:23

Properties

`Protected`channel

channel: string

exmod

exmod: undefined | IBaseKernelModule<IKernel<JwtExtend>>

forceDebug

forceDebug: boolean

logger

logger: null | CoreLogger

mode

mode: ActionMode

requestSchema

requestSchema: null | SSchemaEl

type

type: ActionTypes

Methods

bodyValidation

bodyValidation<A>(req: XRequest): null | ErrorType | A
Type Parameters
- A
Parameters
- req: XRequest
Returns null | ErrorType | A
Inherited from RouteApiAction.bodyValidation
- Defined in src/classes/BaseAction.ts:132

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.debug
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:9

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.error
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:11

getCClient

getCClient<X extends ICoreCClient>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from RouteApiAction.getCClient
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:9

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from RouteApiAction.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:8

getKernel

getKernel(): IKernel
Returns IKernel
Inherited from RouteApiAction.getKernel
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:6

getModule

getModule(): ICoreKernelModule<IKernel<JwtExtend>, any, any, any, any>
Returns ICoreKernelModule<IKernel<JwtExtend>, any, any, any, any>
Inherited from RouteApiAction.getModule
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:7

getName

getName(): string
Returns string
Inherited from RouteApiAction.getName
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:15

handler

handler(__namedParameters: XActionEvent): Promise<void>
Parameters
- __namedParameters: XActionEvent
Returns Promise<void>
Overrides RouteApiAction.handler
- Defined in src/actions/ApiVersionAction.ts:23

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.info
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:10

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Inherited from RouteApiAction.lError
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:14

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.log
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:8

register

register(): void
Returns void
Inherited from RouteApiAction.register
- Defined in src/classes/BaseApiAction.ts:38

secureHandler

secureHandler(req: XRequest, res: XResponse, next: () => void): Promise<void>
Parameters
- req: XRequest
- res: XResponse
- next: () => void
Returns Promise<void>
Inherited from RouteApiAction.secureHandler
- Defined in src/classes/BaseAction.ts:158

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from RouteApiAction.setLogger
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:7

setMode

setMode(mode: ActionMode): void
Parameters
- mode: ActionMode
Returns void
Inherited from RouteApiAction.setMode
- Defined in src/classes/BaseAction.ts:285

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.verbose
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:13

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.warn
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:12

`Static`sendError

sendError(res: XResponse, code: number, error: Partial<ErrorType>): void
Parameters
- res: XResponse
- code: number
- error: Partial<ErrorType>
Returns void
Inherited from RouteApiAction.sendError
- Defined in src/classes/BaseAction.ts:151

`Static`validateSchema

validateSchema(
    error: ErrorType,
    schema: SSchemaEl,
    key: string,
    field: any,
    required?: boolean,
): void
Parameters
- error: ErrorType
- schema: SSchemaEl
- key: string
- field: any
- required: boolean = true
Returns void
Inherited from RouteApiAction.validateSchema
- Defined in src/classes/BaseAction.ts:48