Module: ItemController

Methods

---

<inner> create(req, res)

Create a new Item

with the name from the request's body

Parameters:

Name	Type	Description
req	Object	POST request Properties Name Type Description body Object request's body Properties Name Type Description name string item's name
res	Object	response Properties Name Type Description item Item created Item

Source:

• controllers/item.controller.js, line 14

---

<inner> delete(req, res)

Delete an Item by name

with the name in the request's path

Parameters:

Name	Type	Description
req	Object	DELETE request Properties Name Type Description params Object request's path parameters Properties Name Type Description name string item's name
res	Object	response Properties Name Type Description message string message

Source:

• controllers/item.controller.js, line 242

---

<inner> deleteAll(req, res)

Delete all Items

Parameters:

Name	Type	Description
req	Object	DELETE request
res	Object	response

Source:

• controllers/item.controller.js, line 108

---

<inner> findAll(req, res)

Retrieve all Items

Parameters:

Name	Type	Description
req	Object	GET request
res	Object	response Properties Name Type Description data Array.<Item> list of items

Source:

• controllers/item.controller.js, line 69

---

<inner> findByCategory(req, res)

Retrieve all Items by the category

with the category name in the request's path

Parameters:

Name	Type	Description
req	Object	GET request Properties Name Type Description params Object request's path parameters Properties Name Type Description category string category name
res	Object	response Properties Name Type Description data Array.<Item> list of items belonging to category

Source:

• controllers/item.controller.js, line 336

---

<inner> findOne(req, res)

Find a single Item by name

with the name in the request's path

Parameters:

Name	Type	Description
req	Object	GET request Properties Name Type Description params Object request's path parameters Properties Name Type Description name string item's name
res	Object	response Properties Name Type Description data Item found item

Source:

• controllers/item.controller.js, line 144

---

<inner> findOneById(req, res)

Find a single Item by ID

with the ID in the request's path

Parameters:

Name	Type	Description
req	Object	GET request Properties Name Type Description params Object request's path parameters Properties Name Type Description id string item's ID
res	Object	response Properties Name Type Description data Item found item

Source:

• controllers/item.controller.js, line 291

---

<inner> update(req, res)

Update an Item by name

with the name in the request's path

and the item's details in the request body

Parameters:

Name	Type	Description
req	Object	PUT request Properties Name Type Description params Object request's path parameters Properties Name Type Description name string item's name
res	Object	response Properties Name Type Description message string message

Source:

• controllers/item.controller.js, line 187