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

Represents an abstract core action within the application framework. Core actions define a contract for registering action logic that can be consumed by kernels, clients, caches, and presenters.

Implements

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

Type Parameters

K extends IKernel = IKernel
extends ICoreKernel = ICoreKernel
T extends IDataBase<any, any> | null = any
extends IDataBase<any, any> | null = any
P extends IBaseClient | null = any
extends ICoreClient | null = any
C extends IBaseCache | null = any
extends ICoreCache | null = any
E extends IBasePresenter | null = any
extends ICorePresenter | 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 = IKernel,
    T extends

            | IDataBase<
                any,
                any,
                any,
                ICoreKernel<any, ICoreAnyModule>,
                any,
                any,
                any,
                any,
            >
            | null = any,
    P extends ICoreClient
    | null = any,
    C extends IBaseCache | null = any,
    E extends IBasePresenter | null = any,
>(
    module: IBaseKernelModule<K, T, P, C, E>,
    extMod?: IBaseKernelModule<K>,
): RouteApiAction<K, T, P, C, E>
Type Parameters
- K extends IKernel = IKernel
- T extends
      | IDataBase<
          any,
          any,
          any,
          ICoreKernel<any, ICoreAnyModule>,
          any,
          any,
          any,
          any,
      >
      | null = any
- P extends ICoreClient | null = any
- C extends IBaseCache | null = any
- E extends IBasePresenter | null = 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: IBaseKernelModule<K> | undefined

forceDebug

forceDebug: boolean

logger

logger: CoreLogger | null

mode

mode: ActionMode

requestSchema

requestSchema: string | SSchemaEl | CoreEntity | null

type

type: ActionTypes

Methods

bodyValidation

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

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/CoreKernel-OqPboNJt.d.mts:221

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/CoreKernel-OqPboNJt.d.mts:223

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/CoreKernel-OqPboNJt.d.mts:255

getConfigStore

getConfigStore(): IStore
Returns IStore
Implementation of IBaseAction.getConfigStore

Inherited from BaseApiAction.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:254

getKernel

getKernel(): K
Returns K
Implementation of IBaseAction.getKernel

Inherited from BaseApiAction.getKernel
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:252

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/CoreKernel-OqPboNJt.d.mts:253

getName

getName(): string
Returns string
Implementation of IBaseAction.getName

Inherited from BaseApiAction.getName
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:227

`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:59

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/CoreKernel-OqPboNJt.d.mts:222

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/CoreKernel-OqPboNJt.d.mts:226

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/CoreKernel-OqPboNJt.d.mts:220

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:240

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from BaseApiAction.setLogger
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:219

setMode

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

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/CoreKernel-OqPboNJt.d.mts:225

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/CoreKernel-OqPboNJt.d.mts:224

`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:189

`Static`validateSchema

validateSchema(
    error: ErrorType,
    inputSchema: string | SSchemaEl | CoreEntity,
    key: string,
    field: any,
    required?: boolean,
): void
Parameters
- error: ErrorType
- inputSchema: string | SSchemaEl | CoreEntity
- key: string
- field: any
- required: boolean = true
Returns void
Inherited from BaseApiAction.validateSchema
- Defined in src/classes/BaseAction.ts:61

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

Implements

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 ErrorType | A | null

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

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

`Protected`channel

`Abstract`handler

`Static`sendError

`Static`validateSchema