Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GoneException

Defines an HTTP exception for Gone type errors. Defines an HTTP exception for Gone type errors.

see

Base Exceptions

publicapi
see

Base Exceptions

publicapi

Hierarchy

  • HttpException
  • HttpException
    • GoneException

Index

Constructors

constructor

  • new GoneException(objectOrError: any, description?: string): GoneException
  • Instantiate a GoneException Exception.

    example

    throw new GoneException()

    usagenotes

    The HTTP response status code will be 410.

    • The objectOrError argument defines the JSON response body or the message string.
    • The description argument contains a short description of the HTTP error.

    By default, the JSON response body contains two properties:

    • statusCode: this will be the value 410.
    • message: the string 'Gone' by default; override this by supplying a string in the objectOrError parameter.

    If the parameter objectOrError is a string, the response body will contain an additional property, error, with a short description of the HTTP error. To override the entire JSON response body, pass an object instead. Nest will serialize the object and return it as the JSON response body.

    Parameters

    • objectOrError: any

      string or object describing the error condition.

    • Default value description: string = "Gone"

      a short description of the HTTP error.

    Returns GoneException

Properties

message

message: string

name

name: string

Optional stack

stack: string

Methods

getResponse

  • getResponse(): string | object
  • Returns string | object

getStatus

  • getStatus(): number
  • Returns number

initMessage

  • initMessage(): void
  • Returns void

Static createBody

  • createBody(objectOrError: object | string, description?: string, statusCode?: number): object
  • Parameters

    • objectOrError: object | string
    • Optional description: string
    • Optional statusCode: number

    Returns object

Generated using TypeDoc