Class InitHandler

Init config

Hierarchy

InitHandler

Implements

ICommandHandler

Index

Properties

Methods

Properties

Private params

params: IHandlerParameters

Private promptProps

promptProps: string[]

List of property names that have been prompted for.

Methods

Private initForDryRun

initForDryRun(config: Config, user: boolean): Promise<any>

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.handler.ts:161
Do a dry run of creating JSON template for config. Also create a schema file in the same folder alongside the config.

Parameters
- config: Config
  
  Config object to be populated
- user: boolean
  
  If true, properties will be left empty for user config
Returns Promise<any>

Private initWithSchema

initWithSchema(config: Config, user: boolean, overwrite: boolean): Promise<void>

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.handler.ts:126
Creates JSON template for config. Also creates a schema file in the same folder alongside the config.

Parameters
- config: Config
  
  Config object to be populated
- user: boolean
  
  If true, properties will be left empty for user config
- overwrite: boolean
Returns Promise<void>

process

process(params: IHandlerParameters): Promise<void>

Implementation of ICommandHandler.process
- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.handler.ts:43
Process the command and input.

throws

{ImperativeError}

Parameters
- params: IHandlerParameters
  
  Parameters supplied by yargs
Returns Promise<void>

Private promptForProp

promptForProp(propName: string, property: IProfileProperty): Promise<any>

- Defined in @zowe/imperative/src/imperative/src/config/cmd/init/init.handler.ts:178
Prompts for the value of a property on the CLI. Returns null if --prompt false argument is passed, or prompt times out, or a blank value is entered.

Parameters
- propName: string
  
  The name of the property
- property: IProfileProperty
  
  The profile property definition
Returns Promise<any>

Generated using TypeDoc