Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProfInfoErr

This class is the error exception mechanism for the ProfileInfo API. It is derived from ImperativeError. We use a separate class so that our consumer can check the type of error, and then rely on errorCode values that are unique to ProfInfoErr. ProfInfoErr will always populate the errorCode property. Our consumer can use the errorCode to determine if it should process partial results.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

mDetails

mDetails: IImperativeError

Private mItemsInError

mItemsInError: string[] = []

Additional error properties, specific to ProfInfoErr.

name

name: string

Static Readonly CANT_GET_SCHEMA_URL

CANT_GET_SCHEMA_URL: string = "CantGetSchemaUrl"

Unable to retrieve the schema from a URL reference. Currently, the ProfiInfo API does not attempt to retrieve a schema through a URL. A URL does work to provide intellisense in VSCode when editing a config file.

Static Readonly INVALID_PROF_LOC_TYPE

INVALID_PROF_LOC_TYPE: string = "InvalidProfLocType"

The specified type of profile location is invalid for the requested operation.

Static Readonly LOAD_CRED_MGR_FAILED

LOAD_CRED_MGR_FAILED: string = "LoadCredMgrFailed"

Failed to initialize ProfileCredentials and load the credential manager.

Static Readonly LOAD_SCHEMA_FAILED

LOAD_SCHEMA_FAILED: string = "LoadSchemaFailed"

Failed to load the schema for a specified type of profile.

Static Readonly MISSING_REQ_PROP

MISSING_REQ_PROP: string = "MissingProp"

A required profile property was not assigned a value.

Static Readonly MUST_READ_FROM_DISK

MUST_READ_FROM_DISK: string = "MustReadFromDisk"

The ProfileInfo.readProfilesFromDisk function was not called before a function which requires that prerequisite.

Static Readonly PROF_NOT_FOUND

PROF_NOT_FOUND: string = "ProfileNotFound"

A specified profile was not found (V1)

Static Readonly PROP_NOT_IN_PROFILE

PROP_NOT_IN_PROFILE: string = "PropNotInProfile"

A specified property that is expected to exist in a specified profile does not exist in that profile.

Static Readonly UNKNOWN_PROP_LOCATION

UNKNOWN_PROP_LOCATION: string = "UnknownPropLocation"

A specified property that is expected to exist in a specified profile does not have OS and JSON locations defined.

Accessors

additionalDetails

  • get additionalDetails(): string

causeErrors

  • get causeErrors(): any

details

errorCode

  • get errorCode(): string

itemsInError

  • get itemsInError(): string[]

message

  • get message(): string

stack

  • get stack(): string

suppressDump

  • get suppressDump(): boolean

Methods

Static newImpErrorFromExistingError

  • newImpErrorFromExistingError(existingErr: any, mainMsg?: string): ImperativeError

  • Within the Zowe client SDK, errors are often thrown, caught, modified, and re-thrown. Sometimes the error that we catch is a standard JavaScript Error. Other times the error is already an ImperativeError (which can contain more details). A hard-coded reliance on ImperativeError properties like causeErrors and additionalDetails will not work if the existingErr is a standard JavaScript Error. Also, the properties of an ImperativeError can be nested under various properties within its causeErrors property.

    The purpose of this utility function is to interrogate the existing error to form the most meaningful ImperativeError possible.

    memberof

    ImperativeError

    Parameters

    • existingErr: any
       An existing error to be incorporated into the resulting ImperativeError.
    • Default value mainMsg: string = ""
       The main message text for the resulting ImperativeError. If not supplied,
 the existingErr.message value will be used.

    Returns ImperativeError

    A newly created ImperativeError

Generated using TypeDoc