Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NotFoundException

Defines an HTTP exception for Not Found type errors. Defines an HTTP exception for Not Found type errors.

see

Base Exceptions

publicapi
see

Base Exceptions

publicapi

Hierarchy

  • HttpException
  • HttpException
    • NotFoundException

Index

Constructors

constructor

  • Instantiate a NotFoundException Exception.

    example

    throw new NotFoundException()

    usagenotes

    The HTTP response status code will be 404.

    • 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 404.
    • message: the string 'Not Found' 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 = "Not Found"

      a short description of the HTTP error.

    Returns NotFoundException

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