user - Documentation

Constructor

new user(id, data)

Source:

models/user.js, line 30

class representing an user

Parameters:

Name Type Description

id

number

user id

data

object

contain user data

Properties

Name	Type	Description
`activity`	array	array of objects containing user activity records
`keyData`	object	contain counting indicators
`mainData`	object	contain user main informations
`performances`	object	contain attributes userId , kind
`score`	number	user activity score
`sessions`	array	array of objects containing user sessions records

Methods

getActivity() → {object}

Source:

models/user.js, line 44

provides user activity

Example

return { day: '2020-07-01', kilogram: 80, calories: 240 }

Returns:

data in JSON format

Type: object

getAverageSessions() → {object}

Source:

models/user.js, line 53

provides user average sessions

Example

return { day: 1, sessionLength: 30 }

Returns:

session - data in JSON format

Type: object

getCalorieCount() → {number}

Source:

models/user.js, line 61

provides user calorie count

Returns:

calorie count

Type: number

getCarbohydrateCount() → {number}

Source:

models/user.js, line 69

provides user carbohydrate count

Returns:

carbohydrate count

Type: number

getFirstName() → {string}

Source:

models/user.js, line 97

provides user first name

Returns:

user first name

Type: string

getLipidCount() → {number}

Source:

models/user.js, line 105

provides user lipid count

Returns:

lipid count

Type: number

getPerformances() → {object|number|object|array}

Source:

models/user.js, line 80

provides user performances

Returns:

performances - data in JSON format

Type

object
performances.id - user id

Type

number
performances.kind - { 1: 'cardio, 2: 'energy', 3: 'endurance', 4: 'strength', 5: 'speed', 6: 'intensity'}

Type

object
performances.data - [ {value: 80, kind: 1}, ... ]

Type

array

getProteinCount() → {number}

Source:

models/user.js, line 113

provides user protein count

Returns:

protein count

Type: number

getScore() → {number}

Source:

models/user.js, line 89

provides user score

Example

return 0.25

Returns:

score

Type: number

setData(data)

Source:

models/user.js, line 121

modify the value of attributes activity, averageSessions, keyData, mainData, performances, todayScore

Parameters:

Name	Type	Description
`data`	object	contain user data

setId(id)

Source:

models/user.js, line 136

modify the value of the id attribute

Parameters:

Name	Type	Description
`id`	number	user id