import BeerController from 'beerio-api/src/controllers/BeerController.js'

public class | source

BeerController

Class for CRUD operations for beers.

Constructor Summary

Public Constructor
public	constructor() Create a new BeerController object

Method Summary

Public Methods
public	createBeer(req: Request, res: Response, next: function): JSON Create update an existing beer or create a new beer if not exists.
public	deleteBeer(req: Request, res: Response, next: function): JSON Delete an beer based on the id.
public	getBeer(req: Request, res: Response, next: function): JSON Get a beer based on the id.
public	getBeers(req: Request, res: Response, next: function): JSON Get a list of beers based on the page number and search query.
public	preLoadBeer(req: Request, res: Response, next: function, id: String): Response Attatch a beer object to the req.
public	updateBeer(req: Request, res: Response, next: function): JSON Create update an existing beer or create a new beer if not exists.
public	voteBeer(req: Request, res: Response, next: function): JSON Upvote or downvote an beer based on the id.

Public Constructors

public constructor() source

Create a new BeerController object

Public Methods

public createBeer(req: Request, res: Response, next: function): JSON source

Create update an existing beer or create a new beer if not exists.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.

Return:

JSON	The created or updated beer.

public deleteBeer(req: Request, res: Response, next: function): JSON source

Delete an beer based on the id.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.

Return:

JSON	The deleted beer.

public getBeer(req: Request, res: Response, next: function): JSON source

Get a beer based on the id.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.

Return:

JSON	A beer based on the given id.

public getBeers(req: Request, res: Response, next: function): JSON source

Get a list of beers based on the page number and search query.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.

Return:

JSON	Get a list of beers.

public preLoadBeer(req: Request, res: Response, next: function, id: String): Response source

Attatch a beer object to the req.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.
id	String		The id of the beer to attach.

Return:

Response

A request with a beer object attatched.

public updateBeer(req: Request, res: Response, next: function): JSON source

Create update an existing beer or create a new beer if not exists.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.

Return:

JSON	The updated beer.

public voteBeer(req: Request, res: Response, next: function): JSON source

Upvote or downvote an beer based on the id.

Params:

Name	Type	Attribute	Description
req	Request		The express request object.
res	Response		The express response object.
next	function		The next function for Express.

Return:

JSON	The voted beer.