Fake Mirrors
    Preparing search index...

    Class HttpServerError

    Error class for http-server operation failures.

    Hierarchy (View Summary)

    cause?: unknown

    Associated error code.

    context: ErrorContext

    Additional diagnostic context for the error.

    message: string
    name: string
    stack?: string
    status: number

    Associated HTTP status code.

    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.

    • get isBadGateway(): boolean

      Returns boolean

    • get isBadRequest(): boolean

      Returns boolean

    • get isConflict(): boolean

      Returns boolean

    • get isContentTooLarge(): boolean

      Returns boolean

    • get isForbidden(): boolean

      Returns boolean

    • get isGatewayTimeout(): boolean

      Returns boolean

    • get isInternalError(): boolean

      Returns boolean

    • get isNotFound(): boolean

      Returns boolean

    • get isServiceUnavailable(): boolean

      Returns boolean

    • get isUnauthorized(): boolean

      Returns boolean

    • get isUnprocessableContent(): boolean

      Returns boolean

    • Creates a new http-server error with BAD_GATEWAY code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Creates a new http-server error with BAD_REQUEST code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • 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

    • Creates a new http-server error with CONTENT_TOO_LARGE code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Creates a new http-server error with FORBIDDEN code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Creates a new http-server error with GATEWAY_TIMEOUT code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Creates a new http-server error with INTERNAL_ERROR code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Indicates whether the argument provided is a built-in Error instance or not.

      Parameters

      • error: unknown

      Returns error is Error

    • Creates a new http-server error with NOT_FOUND code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Creates a new http-server error with SERVICE_UNAVAILABLE code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Creates a new http-server error with UNAUTHORIZED code.

      Parameters

      • message: string

        The human-readable description of the error.

      • Optionalcontext: ErrorContext | null

        The optional error context.

      • Optionalcause: unknown

        The optional upstream error.

      Returns HttpServerError

    • Re-throws HttpServerError instances with additional context, or wraps unknown errors into a HttpServerError with an INTERNAL_ERROR code.

      Parameters

      • error: unknown

        The caught error.

      • context: ErrorContext

        The error context.

      Returns HttpServerError