Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BadCredentialManagerError

This class represents the error thrown by methods of the InvalidCredentialManager when initialized by CredentialManagerFactory.initialize

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

mDetails

mDetails: IImperativeError

name

name: string

Accessors

additionalDetails

  • get additionalDetails(): string

causeErrors

  • get causeErrors(): any

details

errorCode

  • get errorCode(): 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