Class SfError<T>

A generalized sfdx error which also contains an action. The action is used in the CLI to help guide users past the error.

To throw an error in a synchronous function you must either pass the error message and actions directly to the constructor, e.g.

// To load a message bundle (Note that __dirname should contain a messages folder)
Messages.importMessagesDirectory(__dirname);
const messages = Messages.load('myPackageName', 'myBundleName');

// To throw a non-bundle based error:
throw new SfError(message.getMessage('myError'), 'MyErrorName');

Type Parameters

  • T extends ErrorDataProperties = ErrorDataProperties

Hierarchy

  • Error
    • SfError

Constructors

constructor

Properties

actions? context? data? exitCode name

Accessors

code

Methods

setContext setData toObject create wrap

Constructors

constructor

  • new SfError<T>(message, name?, actions?, exitCodeOrCause?, cause?): SfError<T>

  • Create an SfError.

    Type Parameters

    • T extends AnyJson = AnyJson

    Parameters

    • message: string

      The error message.

    • name: string = 'SfError'

      The error name. Defaults to 'SfError'.

    • Optionalactions: string[]

      The action message(s).

    • OptionalexitCodeOrCause: number | Error

      The exit code which will be used by SfdxCommand or he underlying error that caused this error to be raised.

    • Optionalcause: unknown

      The underlying error that caused this error to be raised.

    Returns SfError<T>

Properties

Optionalactions

actions?: string[]

Action messages. Hints to the users regarding what can be done to fix related issues.

Optionalcontext

context?: string

The related context for this error.

Optionaldata

data?: T

exitCode

exitCode: number

SfdxCommand can return this process exit code.

Readonlyname

name: string

Accessors

code

Methods

setContext

  • setContext(context): SfError<AnyJson>

  • Sets the context of the error. For convenience this object is returned.

    Parameters

    • context: string

      The command name.

    Returns SfError<AnyJson>

setData

  • setData(data): SfError<AnyJson>

  • An additional payload for the error. For convenience this object is returned.

    Parameters

    • data: T

      The payload data.

    Returns SfError<AnyJson>

toObject

  • toObject(): SfErrorToObjectResult

  • Convert an SfError state to an object. Returns a plain object representing the state of this error.

    Returns SfErrorToObjectResult

Staticcreate

  • create<T>(inputs): SfError<T>

  • like the constructor, but takes an typed object and let you also set context and data properties

    Type Parameters

    • T extends AnyJson = AnyJson

    Parameters

    Returns SfError<T>

Staticwrap

  • wrap<T>(err): SfError<T>

  • Convert an Error to an SfError.

    Type Parameters

    • T extends AnyJson = AnyJson

    Parameters

    • err: unknown

      The error to convert.

    Returns SfError<T>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods