Class CommandHandler<X>`Abstract`

Type Parameters

X = any

Hierarchy (View Summary)

default
- CommandHandler
  - TestScript

Implements

IHandler<X>

Index

Constructors

Properties

Methods

addCmd debug error getCmdName getCmds getData getName getPageSize getStatic info isDev lError log onEnd onStart run setLogger setStatic verbose warn

Constructors

`Protected`constructor

new CommandHandler<X = any>(
    cnf?: {
        cmdName?: string;
        data?: X | null;
        defaultInteractive?: boolean;
        isDev?: boolean;
        logger?: CoreLogger;
        pageSize?: number;
    },
): CommandHandler<X>
Type Parameters
- X = any
Parameters
- Optionalcnf: {
      cmdName?: string;
      data?: X | null;
      defaultInteractive?: boolean;
      isDev?: boolean;
      logger?: CoreLogger;
      pageSize?: number;
  }
Returns CommandHandler<X>
Overrides CoreLogChannel.constructor
- Defined in src/CommandHandler.ts:41

Properties

`Protected`channel

channel: string

`Readonly`logger

logger: CoreLogger

Methods

`Protected`addCmd

addCmd(
    fc: (
        props: { handler: IHandler; logger: CoreLogger },
    ) => ShellCommand<any>[],
): void
Parameters
- fc: (props: { handler: IHandler; logger: CoreLogger }) => ShellCommand<any>[]
Returns void
- Defined in src/CommandHandler.ts:87

debug

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

error

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

getCmdName

getCmdName(): string
Get the script name

Returns string
Implementation of IHandler.getCmdName
- Defined in src/CommandHandler.ts:83

getCmds

getCmds(full?: boolean): ShellCommand<any>[]
Get the command list
Parameters
- Optionalfull: boolean
Returns ShellCommand<any>[]
Implementation of IHandler.getCmds
- Defined in src/CommandHandler.ts:101

getData

getData(): X | null
get data from the command handler

Returns X | null
Implementation of IHandler.getData
- Defined in src/CommandHandler.ts:167

getName

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

getPageSize

getPageSize(): number | undefined
Get the default interactive page size

Returns number | undefined
Implementation of IHandler.getPageSize
- Defined in src/CommandHandler.ts:175

getStatic

getStatic(key: string): string
Parameters
- key: string
Returns string
Implementation of IHandler.getStatic
- Defined in src/CommandHandler.ts:76

info

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

isDev

isDev(): boolean
Get the dev mode state

Returns boolean
Implementation of IHandler.isDev
- Defined in src/CommandHandler.ts:171

lError

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

log

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

onEnd

onEnd(): void
function triggered when the command is ended

Returns void
Implementation of IHandler.onEnd
- Defined in src/CommandHandler.ts:163

onStart

onStart(): Promise<void>
Returns Promise<void>
- Defined in src/CommandHandler.ts:159

run

run(iArgs?: InteractionArgs): Promise<void>
Parameters
- OptionaliArgs: InteractionArgs
Returns Promise<void>
- Defined in src/CommandHandler.ts:108

setLogger

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

setStatic

setStatic(key: string, value: any): void
Set a static value
Parameters
- key: string
- value: any
Returns void
Implementation of IHandler.setStatic
- Defined in src/CommandHandler.ts:72

verbose

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

warn

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