Interface IHandler<X>

interface IHandler<X = any> {
    getCmdName(): string;
    getCmds(full?: boolean): ShellCommand<any>[];
    getData(): X | null;
    getPageSize(): number | undefined;
    getStatic(key: string): string;
    isDev(): boolean;
    onEnd(): void;
    setStatic(key: string, value: any): void;
}

Type Parameters

X = any

Implemented by

CommandHandler

Index

Methods

getCmdName getCmds getData getPageSize getStatic isDev onEnd setStatic

Methods

getCmdName

getCmdName(): string
Get the script name

Returns string
- Defined in src/lib/types.ts:16

getCmds

getCmds(full?: boolean): ShellCommand<any>[]
Get the command list
Parameters
- Optionalfull: boolean
Returns ShellCommand<any>[]
- Defined in src/lib/types.ts:11

getData

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

Returns X | null
- Defined in src/lib/types.ts:35

getPageSize

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

Returns number | undefined
- Defined in src/lib/types.ts:26

getStatic

getStatic(key: string): string
Parameters
- key: string
Returns string
- Defined in src/lib/types.ts:47

isDev

isDev(): boolean
Get the dev mode state

Returns boolean
- Defined in src/lib/types.ts:21

onEnd

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

Returns void
- Defined in src/lib/types.ts:31

setStatic

setStatic(key: string, value: any): void
Set a static value
Parameters
- key: string
- value: any
Returns void
- Defined in src/lib/types.ts:42