JSDoc: Global

Members

(constant) authorizations

'api/confirm-email-tokens' authorization list.

Source:

controllers/#template/authorizations.config.js, line 7

(constant) authorizations

'api/confirm-email-tokens' authorization list.

Source:

controllers/confirmEmailTokens/authorizations.config.js, line 7

(constant) authorizations

'api/authorization-tokens' authorization list.

Source:

controllers/resetTokens/authorizations.config.js, line 7

(constant) authorizations

'api/things' authorization list.

Source:

controllers/things/authorizations.config.js, line 7

(constant) authorizations

'api/users' authorization list.

Source:

controllers/users/authorizations.config.js, line 7

(constant) CONFIRM_EMAIL_TOKENS

URL Endpoint 'api/confirm-email-tokens'

Source:

controllers/#template/authorizations.config.js, line 12

(constant) CONFIRM_EMAIL_TOKENS

URL Endpoint 'api/confirm-email-tokens'

Source:

controllers/confirmEmailTokens/authorizations.config.js, line 12

(constant) jwt

JWT strategy verifies that the token sent by the user is valid.

Source:

configs/passport.config.js, line 65

(constant) local

Local strategy used to check supplied email and password against database.

Source:

configs/passport.config.js, line 32

(constant) RESET_TOKENS

URL Endpoint 'api/authorization-tokens'.

Source:

controllers/resetTokens/authorizations.config.js, line 12

(constant) sequelize

Sequelize instance to be referenced through the server

Source:

database/index.js, line 9

server

Express server export for testing

Source:

app.js, line 38

(constant) server

Express server instance

Source:

server.js, line 32

(constant) THINGS

URL Endpoint 'api/things'.

Source:

controllers/things/authorizations.config.js, line 12

(constant) USERS

URL Endpoint 'api/users'

Source:

controllers/users/authorizations.config.js, line 12

Type Definitions

ConfirmEmailToken

Definition of the ResetToken database model

Type:

Object

Properties:

Name	Type	Description
`UserId`	Int	Foreign Key id.
`token`	String	64bit random token.
`expiration`	Date	When the token expires.

Source:

database/models/confirmEmailToken.model.js, line 14

ResetToken

Definition of the ResetToken database model

Type:

Object

Properties:

Name	Type	Description
`UserId`	Int	Foreign Key id.
`token`	String	A JSON Web Token.
`expiration`	Date	When does the reset token expire.
`isUsed`	Boolean	Has the reset token already been used.

Source:

database/models/resetToken.model.js, line 14

Thing

Definition of the Thing database model

Type:

Object

Properties:

Name	Type	Description
`name`	String	Name of the Thing
`description`	String	Description of the Thing.
`price`	Decimal	The price of the Thing.

Source:

database/models/thing.model.js, line 11

User

Definition of the User database model

Type:

Object

Properties:

Name	Type	Description
`firstName`	String	First name of the User.
`lastName`	String	Second name of the User
`fullName`	String	First and second name of the User.
`email`	String	Email address of the user.
`password`	String	Hashed password for the user to login with.
`salt`	String	Salt used to hash the password for the User.
`lastLogin`	Date	When was the last time the User logged in.
`status`	Enum	The status of the User account.
`role`	Enum	The role of the user has.
`isEmailConfirmed`	Boolean	Has the user confirmed there email address.

Source:

database/models/user.model.js, line 14