Class ConfigUtils

Hierarchy

ConfigUtils

Index

Methods

Methods

Static coercePropValue

coercePropValue(value: any, type?: string): any

- Defined in @zowe/imperative/src/config/src/ConfigUtils.ts:24
Coeerces string property value to a boolean or number type.

Parameters
- value: any
  
  String value
- Optional type: string
  
  Property type defined in the schema
Returns any

Boolean, number, or string

Static getActiveProfileName

getActiveProfileName(profileType: string, cmdArguments?: ICommandArguments, defaultProfileName?: string): string

- Defined in @zowe/imperative/src/config/src/ConfigUtils.ts:50
Retrieves the name of the active profile for the given type. If no such profile exists, returns the default name which can be used to create a new profile.

Parameters
- profileType: string
  
  The type of CLI profile
- Optional cmdArguments: ICommandArguments
  
  CLI arguments which may specify a profile
- Optional defaultProfileName: string
  
  Name to fall back to if profile doesn't exist. If not specified, the profile type will be used.
Returns string

The profile name

Static jsonPathMatches

jsonPathMatches(fullPath: string, partialPath: string): boolean

- Defined in @zowe/imperative/src/config/src/ConfigUtils.ts:64
Checks if partial path is equal to or nested inside full path

Parameters
- fullPath: string
  
  JSON path to profile 1
- partialPath: string
  
  JSON path to profile 2
Returns boolean

Static secureSaveError

secureSaveError(solution?: string): ImperativeError

- Defined in @zowe/imperative/src/config/src/ConfigUtils.ts:73
Form an error message for failures to securely save a value.

Parameters
- Optional solution: string
  
  Text that our caller can supply for a solution.
Returns ImperativeError

ImperativeError to be thrown

Generated using TypeDoc