Class APIError

constructor

• new APIError(
      statusCode: number,
      errorType: APIErrorType,
      errorMessage: string,
      correlationId?: string,
      errorLink?: string,
      cause?: Error,
  ): APIError

  Parameters

  • statusCode: number
  • errorType: APIErrorType
  • errorMessage: string
  • OptionalcorrelationId: string
  • OptionalerrorLink: string
  • Optionalcause: Error

  Returns APIError

toJSON

• toJSON(): {
      errorLink?: string;
      correlationId?: string;
      name: string;
      statusCode: number;
      errorType: APIErrorType;
      errorMessage: string;
  }

  Returns {
      errorLink?: string;
      correlationId?: string;
      name: string;
      statusCode: number;
      errorType: APIErrorType;
      errorMessage: string;
  }

statusCode

errorType

errorMessage

OptionalcorrelationId

OptionalerrorLink