Class GetTokenAction

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>

Hierarchy (View Summary)

RouteApiAction
- GetTokenAction

Index

Constructors

constructor

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

Properties

`Protected`channel

channel: string

exmod

exmod: IBaseKernelModule<IKernel> | 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 RouteApiAction.bodyValidation
- Defined in src/classes/BaseAction.ts:170

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.debug
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:221

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.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
Inherited from RouteApiAction.getCClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:255

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from RouteApiAction.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:254

getKernel

getKernel(): IKernel
Returns IKernel
Inherited from RouteApiAction.getKernel
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:252

getModule

getModule(): ICoreKernelModule<IKernel, any, any, any, any>
Returns ICoreKernelModule<IKernel, any, any, any, any>
Inherited from RouteApiAction.getModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:253

getName

getName(): string
Returns string
Inherited from RouteApiAction.getName
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:227

handler

handler(__namedParameters: XActionEvent<JwtToken, SchemaType>): Promise<void>
Parameters
- __namedParameters: XActionEvent<JwtToken, SchemaType>
Returns Promise<void>
Overrides RouteApiAction.handler
- Defined in src/actions/GetTokenAction.ts:67

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.info
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:222

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Inherited from RouteApiAction.lError
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:226

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.log
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:220

register

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

setLogger

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

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from RouteApiAction.verbose
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:225

warn

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

Class GetTokenAction

Implements

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns GetTokenAction

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 IKernel

getModule

Returns ICoreKernelModule<IKernel, any, any, any, any>

getName

Returns string

handler

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

`Protected`channel

`Static`sendError

`Static`validateSchema