Jira.js - Jira Cloud API library
    Preparing search index...

    Class HttpException

    Defines the base HTTP exception, which is handled by the default Exceptions Handler.

    Hierarchy

    • Error
      • HttpException
    Index

    Constructors

    • Instantiate a plain HTTP Exception.

      Parameters

      • response: string | Record<string, any>

        String, object describing the error condition or the error cause.

      • Optionalstatus: number

        HTTP response status code.

      • Optionaloptions: HttpExceptionOptions

        An object used to add an error cause. Configures error chaining support

      Returns HttpException

      throw new HttpException('message', HttpStatus.BAD_REQUEST);
      throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {
      cause: new Error('Cause Error'),
      });

      The constructor arguments define the response and the HTTP response status code.

      • The response argument (required) defines the JSON response body. alternatively, it can also be an error object that is used to define an error cause.
      • The status argument (optional) defines the HTTP Status Code.
      • The options argument (optional) defines additional error options. Currently, it supports the cause attribute, and can be used as an alternative way to specify the error cause: const error = new HttpException('description', 400, { cause: new Error() });

      By default, the JSON response body contains two properties:

      • statusCode: the Http Status Code.
      • message: a short description of the HTTP error by default; override this by supplying a string in the response parameter.

      The status argument is required, and should be a valid HTTP status code. Best practice is to use the HttpStatus enum imported from nestjs/common.

    Properties

    cause?: unknown
    code?: string
    message: string
    name: string
    response: string | Record<string, any>

    String, object describing the error condition or the error cause.

    stack?: string
    status: number
    statusText?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Parameters

      • response: string | Record<string, any>

      Returns string

    • Parameters

      • response: string | Record<string, any>

      Returns any

    • Parameters

      • response: string | Record<string, any>
      • Optionalstatus: number

      Returns number

    • Parameters

      • response: string | Record<string, any>
      • Optionalstatus: number

      Returns undefined | string

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack; // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
      b();
      }

      function b() {
      c();
      }

      function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any