Class ConfigBuilder

Hierarchy

ConfigBuilder

Index

Methods

Methods

Static build

build(impConfig: IImperativeConfig, opts?: IConfigBuilderOpts): Promise<IConfig>

- Defined in @zowe/imperative/src/config/src/ConfigBuilder.ts:29
Build a new Config object from an Imperative CLI app configuration.

Parameters
- impConfig: IImperativeConfig
  
  The Imperative CLI app configuration.
- Optional opts: IConfigBuilderOpts
  
  Options to control aspects of the builder.
Returns Promise<IConfig>

Static buildDefaultProfile

buildDefaultProfile(profile: ICommandProfileTypeConfiguration, opts?: IConfigBuilderOpts): { properties: Record<string, any>; secure: string[]; type: string }

- Defined in @zowe/imperative/src/config/src/ConfigBuilder.ts:59
Parameters
- profile: ICommandProfileTypeConfiguration
- Optional opts: IConfigBuilderOpts
Returns { properties: Record<string, any>; secure: string[]; type: string }
- properties: Record<string, any>
- secure: string[]
- type: string

Static convert

convert(profilesRootDir: string): Promise<IConfigConvertResult>

- Defined in @zowe/imperative/src/config/src/ConfigBuilder.ts:95
Convert existing v1 profiles to a Config object and report any conversion failures.

Parameters
- profilesRootDir: string
  
  Root directory where v1 profiles are stored.
Returns Promise<IConfigConvertResult>

Results object including new config and error details for profiles that failed to convert.

Static Private convertPropNames

convertPropNames(conversionResult: IConfigConvertResult): void

- Defined in @zowe/imperative/src/config/src/ConfigBuilder.ts:164
Convert a set of known property names that have been renamed for V2 conformance to their new names.

Parameters
- conversionResult: IConfigConvertResult
  
  The conversion result structure in which we shall rename obsolete property names to their V2-compliant names.
Returns void

Static Private getDefaultValue

getDefaultValue(propType: string | string[]): any

- Defined in @zowe/imperative/src/config/src/ConfigBuilder.ts:224
Returns empty value that is appropriate for the property type.

Parameters
- propType: string | string[]
  
  The type of profile property
Returns any

Null or empty object

Generated using TypeDoc