Class ClusterCommandHandlers

Hierarchy (View Summary)

CommandHandler
- ClusterCommandHandlers

Index

Constructors

Properties

_configMaps logger? CONNECT_COMMAND SETUP_COMMAND

Methods

commandAction connect disconnect getUnusedConfigs info list reset setup setupHomeDirectory setupHomeDirectoryTask

Constructors

constructor

new ClusterCommandHandlers(
    tasks: ClusterCommandTasks,
    localConfig: LocalConfigRuntimeState,
    configs: ClusterCommandConfigs,
): ClusterCommandHandlers
Parameters
- tasks: ClusterCommandTasks
- localConfig: LocalConfigRuntimeState
- configs: ClusterCommandConfigs
Returns ClusterCommandHandlers
Overrides CommandHandler.constructor
- Defined in src/commands/cluster/handlers.ts:21

Properties

`Protected` `Readonly`_configMaps

_configMaps: Map<string, any> = ...

`Optional` `Readonly`logger

logger?: SoloLogger

`Static` `Readonly`CONNECT_COMMAND

CONNECT_COMMAND: string = 'cluster-ref connect'

`Static` `Readonly`SETUP_COMMAND

SETUP_COMMAND: string = 'cluster-ref setup'

Methods

commandAction

commandAction(
    argv: any,
    actionTasks: any,
    options: any,
    errorString: string,
    lease: Lock,
    commandName?: string,
): Promise<void>
Parameters
- argv: any
- actionTasks: any
- options: any
- errorString: string
- lease: Lock
- commandName: string = 'command'
Returns Promise<void>
Inherited from CommandHandler.commandAction
- Defined in src/core/command-handler.ts:33

connect

connect(argv: ArgvStruct): Promise<boolean>
- Setup home directory.
- Create new local config if needed.
- Add new 'cluster-ref => context' mapping in the local config.
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/cluster/handlers.ts:38

disconnect

disconnect(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/cluster/handlers.ts:61

getUnusedConfigs

getUnusedConfigs(configName: string): string[]
Parameters
- configName: string
Returns string[]
Inherited from CommandHandler.getUnusedConfigs
- Defined in src/core/command-handler.ts:104

info

info(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/cluster/handlers.ts:98

list

list(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/cluster/handlers.ts:81

reset

reset(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/cluster/handlers.ts:141

setup

setup(argv: ArgvStruct): Promise<boolean>
Parameters
- argv: ArgvStruct
Returns Promise<boolean>
- Defined in src/commands/cluster/handlers.ts:115

setupHomeDirectory

setupHomeDirectory(directories?: string[]): string[]
Setup home directories
Parameters
- directories: string[] = ...
Returns string[]
Inherited from CommandHandler.setupHomeDirectory
- Defined in src/core/command-handler.ts:71

setupHomeDirectoryTask

setupHomeDirectoryTask(): { task: () => Promise<void>; title: string }
Returns { task: () => Promise<void>; title: string }
Inherited from CommandHandler.setupHomeDirectoryTask
- Defined in src/core/command-handler.ts:95