Class AmplifyError<T>Abstract

constructor

• new AmplifyError<T extends string = string>(
      name: T,
      classification: AmplifyErrorClassification,
      options: AmplifyErrorOptions,
      cause?: Error,
  ): AmplifyError<T>

  You should use AmplifyUserError or AmplifyLibraryFault to throw an error.

  Type Parameters

  • T extends string = string

  Parameters

  • name: T

    a user friendly name for the exception
  • classification: AmplifyErrorClassification

    LibraryFault or UserError
  • options: AmplifyErrorOptions

    error stack, resolution steps, details, or help links
  • Optionalcause: Error

    If you are throwing this exception from within a catch block, you must provide the exception that was caught.

  Returns AmplifyError<T>

  Example

  try {
   ...
  } catch (error){
     throw new AmplifyError(...,...,error);
  }
  Copy

Readonlyclassification

Optional Readonlycode

Optional Readonlydetails

Optional Readonlylink

Readonlymessage

Optional Readonlyresolution

OptionalserializedError

StaticfromError

• fromError(error: unknown): AmplifyError

  Parameters

  • error: unknown

  Returns AmplifyError

StaticfromStderr

• fromStderr(_stderr: string): undefined | AmplifyError<string>

  Parameters

  • _stderr: string

  Returns undefined | AmplifyError<string>

StaticisAmplifyError

• isAmplifyError(error: unknown): error is AmplifyError<string>

  This function is a type predicate for AmplifyError. See https://www.typescriptlang.org/docs/handbook/2/narrowing.html#using-type-predicates.

  Checks if error is an AmplifyError by inspecting if required properties are set. This is recommended instead of instanceof operator. The instance of operator does not work as expected if AmplifyError class is loaded from multiple sources, for example when package manager decides to not de-duplicate dependencies. See https://github.com/nodejs/node/issues/17943.

  Parameters

  • error: unknown

  Returns error is AmplifyError<string>