Module: UserController

Methods

---

<inner> addItemToUser(req, res)

Add an Item to a User's bucket list

with the user's auth token from the request's path

and the item's name and checked status from the request's body

Parameters:

Name	Type	Description
req	Object	POST request Properties Name Type Description params Object request's path parameters Properties Name Type Description user string user's auth token body Object request's body Properties Name Type Argument Description item string item's name checked boolean | undefined <optional> item's checked status
res	Object	response Properties Name Type Description message string message

Source:

• controllers/user.controller.js, line 370

---

<inner> create(req, res)

Create a new User

with the auth ID token and name(optional) 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 Argument Description idToken Number user's auth ID token name string | undefined <optional> user's name
res	Object	response Properties Name Type Description user User created User

Source:

• controllers/user.controller.js, line 32

---

<inner> delete(req, res)

Delete a User by ID

with the ID 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 id string user's ID
res	Object	response Properties Name Type Description message string message

Source:

• controllers/user.controller.js, line 321

---

<inner> deleteAll(req, res)

Delete all Users

Parameters:

Name	Type	Description
req	Object	DELETE request
res	Object	response

Source:

• controllers/user.controller.js, line 128

---

<inner> deleteItemFromUser(req, res)

Delete an item from a User with token

with the user's auth ID token and the item's name on 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 user string user's auth token item string item's name
res	Object	response Properties Name Type Description message string message

Source:

• controllers/user.controller.js, line 525

---

<inner> findAll(req, res)

Retrieve all Users

Parameters:

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

Source:

• controllers/user.controller.js, line 89

---

<inner> findByIdToken(req, res)

Find User by auth ID token

with the auth ID token in the request's path

Parameters:

Name	Type	Description
req	Object	POST request Properties Name Type Description params Object request's path parameters Properties Name Type Description idToken Number user's auth ID token
res	Object	response Properties Name Type Description data User found user

Source:

• controllers/user.controller.js, line 164

---

<inner> findOne(req, res)

Find a single User 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 user's ID
res	Object	response Properties Name Type Description data User found user

Source:

• controllers/user.controller.js, line 219

---

<inner> getLoginRadiusProfile(token)

Get User profile from Login Radius

Parameters:

Name	Type	Description
token	string	User's token

Source:

• controllers/user.controller.js, line 577

Returns:

User's profile

Type

Object | null

---

<inner> update(req, res)

Update a User by ID

with the ID in the request's path and the user's details from the request's body

Parameters:

Name	Type	Description
req	Object	PUT request Properties Name Type Description params Object request's path parameters Properties Name Type Description id string user's ID body Object request's body Properties Name Type Argument Description idToken Number | undefined <optional> user's auth ID token name string | undefined <optional> user's name
res	Object	response Properties Name Type Description message string message

Source:

• controllers/user.controller.js, line 265

---

<inner> updateItemFromUser(req, res)

Update an item from a User with token

with the user's auth ID token and the item's name on the request's path

and the item's checked status on the request's body

Parameters:

Name	Type	Description
req	Object	PUT request Properties Name Type Description params Object request's path parameters Properties Name Type Description user string user's auth token item string item's name body Object request's body Properties Name Type Description checked boolean item's checked status
res	Object	response Properties Name Type Description message string message

Source:

• controllers/user.controller.js, line 461