Class ShellCommand<T>`Abstract`

Type Parameters

T = any

Hierarchy

default
- ShellCommand

Index

Constructors

Properties

channel description handler level logger name properties subCommands

Methods

debug error getName getStatic info lError log resolvePath run setLogger start verbose warn

Constructors

`Protected`constructor

new ShellCommand<T = any>(conf: ShellCommandProps): ShellCommand<T>
Type Parameters
- T = any
Parameters
- conf: ShellCommandProps
Returns ShellCommand<T>
Overrides CoreLogChannel.constructor
- Defined in src/class/ShellComand.ts:37

Properties

`Protected`channel

channel: string

description

description: string

handler

handler: IHandler<T>

level

level: number

logger

logger: CoreLogger | null

name

name: string

properties

properties: CmdProperty[]

subCommands

subCommands: ShellCommand<any>[]

Methods

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

getName

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

`Protected`getStatic

getStatic(key: string): string | undefined
Parameters
- key: string
Returns string | undefined
- Defined in src/class/ShellComand.ts:106

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

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

`Protected`resolvePath

resolvePath(path?: ParamTypeRaw): string
Parameters
- Optionalpath: ParamTypeRaw
Returns string
- Defined in src/class/ShellComand.ts:95

`Abstract`run

run(parser: IArgs): Promise<boolean>
Parameters
- parser: IArgs
Returns Promise<boolean>
- Defined in src/class/ShellComand.ts:93

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

start

start(parser: IArgs): Promise<boolean>
Parameters
- parser: IArgs
Returns Promise<boolean>
- Defined in src/class/ShellComand.ts:77

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