Class RouteApiAction<K, T, P, C, E>`Abstract`

Type Parameters

K extends IKernel = IKernel
T extends IDataBase<any, any> | null = any
P extends IBaseClient | null = any
C extends IBaseCache | null = any
E extends IBasePresenter | null = any

Hierarchy (View Summary)

BaseApiAction<K, T, P, C, E>
- RouteApiAction

Implements

IBaseAction<K, T, P, C, E>

Index

Constructors

constructor

new RouteApiAction<
    K extends IKernel<JwtExtend> = IKernel<JwtExtend>,
    T extends

            | null
            | IDataBase<
                any,
                any,
                ICoreKernel<any, ICoreAnyModule>,
                any,
                any,
                any,
                any,
            > = any,
    P extends null
    | ICoreClient = any,
    C extends null | IBaseCache = any,
    E extends null | IBasePresenter = any,
>(
    module: IBaseKernelModule<K, T, P, C, E>,
    extMod?: IBaseKernelModule<K>,
): RouteApiAction<K, T, P, C, E>
Type Parameters
- K extends IKernel<JwtExtend> = IKernel<JwtExtend>
- T extends null | IDataBase<any, any, ICoreKernel<any, ICoreAnyModule>, any, any, any, any> = any
- P extends null | ICoreClient = any
- C extends null | IBaseCache = any
- E extends null | IBasePresenter = any
Parameters
- module: IBaseKernelModule<K, T, P, C, E>
- OptionalextMod: IBaseKernelModule<K>
Returns RouteApiAction<K, T, P, C, E>
Overrides BaseApiAction.constructor
- Defined in src/classes/RouteApiAction.ts:23

Properties

`Protected`channel

channel: string

exmod

exmod: undefined | IBaseKernelModule<K>

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 BaseApiAction.bodyValidation
- Defined in src/classes/BaseAction.ts:132

debug

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

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IBaseAction.error
Inherited from BaseApiAction.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
Implementation of IBaseAction.getCClient
Inherited from BaseApiAction.getCClient
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:9

getConfigStore

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

getKernel

getKernel(): K
Returns K
Implementation of IBaseAction.getKernel
Inherited from BaseApiAction.getKernel
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:6

getModule

getModule(): ICoreKernelModule<K, T, P, C, E>
Returns ICoreKernelModule<K, T, P, C, E>
Implementation of IBaseAction.getModule
Inherited from BaseApiAction.getModule
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreElement.d.ts:7

getName

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

`Abstract`handler

handler(event: XActionEvent): Promise<void>
Parameters
- event: XActionEvent
Returns Promise<void>
Implementation of IBaseAction.handler
Inherited from BaseApiAction.handler
- Defined in src/classes/BaseAction.ts:46

info

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

lError

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

log

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

register

register(): void
Returns void
Implementation of IBaseAction.register
Inherited from BaseApiAction.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 BaseApiAction.secureHandler
- Defined in src/classes/BaseAction.ts:158

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from BaseApiAction.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 BaseApiAction.setMode
- Defined in src/classes/BaseAction.ts:285

verbose

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

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Implementation of IBaseAction.warn
Inherited from BaseApiAction.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 BaseApiAction.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 BaseApiAction.validateSchema
- Defined in src/classes/BaseAction.ts:48

Class RouteApiAction<K, T, P, C, E>Abstract

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RouteApiAction<K, T, P, C, E>

Properties

Protectedchannel

exmod

forceDebug

logger

mode

requestSchema

type

Methods

bodyValidation

Type Parameters

Parameters

Returns null | ErrorType | A

debug

Parameters

Returns void

error

Parameters

Returns void

getCClient

Type Parameters

Returns X

getConfigStore

Returns IStore

getKernel

Returns K

getModule

Returns ICoreKernelModule<K, T, P, C, E>

getName

Returns string

Abstracthandler

Parameters

Returns Promise<void>

info

Parameters

Returns void

lError

Parameters

Returns Error

log

Parameters

Returns void

register

Returns void

secureHandler

Parameters

Returns Promise<void>

setLogger

Parameters

Returns void

setMode

Parameters

Returns void

verbose

Parameters

Returns void

warn

Parameters

Returns void

StaticsendError

Parameters

Returns void

StaticvalidateSchema

Parameters

Returns void

Settings

On This Page

Class RouteApiAction<K, T, P, C, E>`Abstract`

`Protected`channel

`Abstract`handler

`Static`sendError

`Static`validateSchema