Class APIError

constructor

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

  Constructor for the APIError class

  Parameters

  • statusCode: number

    The HTTP status code
  • errorType: APIErrorType

    The type of error
  • errorMessage: string

    The error message
  • OptionalcorrelationId: string

    The correlation ID
  • OptionalerrorLink: string

    URL to documentation about this error
  • Optionalcause: Error

    The cause of the error

  Returns APIError

OptionalcorrelationId

OptionalerrorLink

errorMessage

errorType

statusCode

toJSON

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

  Convert the error to a JSON object, excluding undefined properties

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

  The error as a JSON object