Class BaseApiAction<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

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

Implements

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

Index

Constructors

Properties

channel exmod forceDebug logger mode type

Methods

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

Constructors

constructor

new BaseApiAction<K, T, P, C, E>(type, chanel, module, extMod?): BaseApiAction<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
- type: ActionTypes
- chanel: string
- module: IBaseKernelModule<K, T, P, C, E>
- Optional extMod: IBaseKernelModule<K>
Returns BaseApiAction<K, T, P, C, E>
Overrides BaseAction.constructor
- Defined in src/classes/BaseApiAction.ts:27

Properties

`Protected` channel

channel: string

exmod

exmod: undefined | IBaseKernelModule<K>

forceDebug

forceDebug: boolean

logger

logger: null | CoreLogger

mode

mode: ActionMode

type

type: ActionTypes

Methods

debug

debug(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Implementation of IBaseAction.debug

Inherited from BaseAction.debug
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:9

error

error(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Implementation of IBaseAction.error

Inherited from BaseAction.error
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:11

getCClient

getCClient<X>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Implementation of IBaseAction.getCClient

Inherited from BaseAction.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 BaseAction.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 BaseAction.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 BaseAction.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 BaseAction.getName
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:15

`Abstract` handler

handler(event): Promise<void>
Parameters
- event: XActionEvent
Returns Promise<void>
Implementation of IBaseAction.handler

Inherited from BaseAction.handler
- Defined in src/classes/BaseAction.ts:40

info

info(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Implementation of IBaseAction.info

Inherited from BaseAction.info
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:10

lError

lError(message): Error
Parameters
- message: string
Returns Error
Implementation of IBaseAction.lError

Inherited from BaseAction.lError
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:14

log

log(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Implementation of IBaseAction.log

Inherited from BaseAction.log
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:8

register

register(): void
Returns void
Implementation of IBaseAction.register

Overrides BaseAction.register
- Defined in src/classes/BaseApiAction.ts:38

secureHandler

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

setLogger

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

setMode

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

verbose

verbose(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Implementation of IBaseAction.verbose

Inherited from BaseAction.verbose
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:13

warn

warn(...ags): void
Parameters
- Rest ...ags: unknown[]
Returns void
Implementation of IBaseAction.warn

Inherited from BaseAction.warn
- Defined in node_modules/@grandlinex/core/dist/mjs/classes/CoreLogChannel.d.ts:12

Generated using TypeDoc