Module utils/cannedHTTPResponses

Index

Functions

Functions

badRequest

badRequest(res: Response, detail?: string | {}): void

- Defined in src/utils/cannedHTTPResponses.ts:19
Terminates a request with status code 400, default message field and optional detail string.

Parameters
- res: Response
  
  Express response object.
- Optional detail: string | {}
  
  Optional string or object wiht extra details.
Returns void

internalServerError

internalServerError(res: Response, detail?: string | {}): void

- Defined in src/utils/cannedHTTPResponses.ts:49
Terminates a request with status code 500, default message field and optional detail string.

Parameters
- res: Response
  
  Express response object.
- Optional detail: string | {}
  
  Optional string or object wiht extra details.
Returns void

notFound

notFound(res: Response, detail?: string | {}): void

- Defined in src/utils/cannedHTTPResponses.ts:39
Terminates a request with status code 404, default message field and optional detail string.

Parameters
- res: Response
  
  Express response object.
- Optional detail: string | {}
  
  Optional string or object wiht extra details.
Returns void

ok

ok(res: Response, detail?: string | {}): void

- Defined in src/utils/cannedHTTPResponses.ts:9
Terminates a request with status code 200, default message field and optional detail string.

Parameters
- res: Response
  
  Express response object.
- Optional detail: string | {}
  
  Optional string or object wiht extra details.
Returns void

unauthorized

unauthorized(res: Response, detail?: string | {}): void

- Defined in src/utils/cannedHTTPResponses.ts:29
Terminates a request with status code 401, default message field and optional detail string.

Parameters
- res: Response
  
  Express response object.
- Optional detail: string | {}
  
  Optional string or object wiht extra details.
Returns void

Generated using TypeDoc