@aws-amplify/core/src/errors/AmplifyError.ts

Core category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
import { AmplifyErrorParams, ResponseMetadata } from '../types/errors';

export class AmplifyError extends Error {
	readonly underlyingError?: Error | unknown;
	readonly recoverySuggestion?: string;
	/**
	 * Additional metadata that can be used to provide more context to the error.
	 */
	readonly metadata?: ResponseMetadata;
	/**
	 *  Constructs an AmplifyError.
	 *
	 * @param message text that describes the main problem.
	 * @param underlyingError the underlying cause of the error.
	 * @param recoverySuggestion suggestion to recover from the error.
	 *
	 */
	constructor({
		message,
		name,
		recoverySuggestion,
		underlyingError,
		metadata,
	}: AmplifyErrorParams) {
		super(message);

		this.name = name;
		this.underlyingError = underlyingError;
		this.recoverySuggestion = recoverySuggestion;
		if (metadata) {
			// If metadata exists, explicitly only record the following properties.
			const { extendedRequestId, httpStatusCode, requestId } = metadata;
			this.metadata = { extendedRequestId, httpStatusCode, requestId };
		}

		// Hack for making the custom error class work when transpiled to es5
		// TODO: Delete the following 2 lines after we change the build target to >= es2015
		this.constructor = AmplifyError;
		Object.setPrototypeOf(this, AmplifyError.prototype);
	}
}