Skip to content
Snippets Groups Projects
Commit 2feba43d authored by Bastien DUMONT's avatar Bastien DUMONT :angel:
Browse files

chore: add jsdoc to models

parent 841f60ec
No related branches found
No related tags found
No related merge requests found
...@@ -19,11 +19,17 @@ export interface DataloadEntity { ...@@ -19,11 +19,17 @@ export interface DataloadEntity {
_id?: string _id?: string
_type?: string _type?: string
_rev?: string _rev?: string
day: number /** load (in kWh or L) */
hour: number
load: number load: number
/** minute of the date, set to 0 except for minute series */
minute: number minute: number
/** hour of the date, set to 0 except for minute and hour series */
hour: number
/** day of the date, set to 1 for month and year series */
day: number
/** month of the date, set to 1 for year series */
month: number month: number
/** year of the date */
year: number year: number
price?: number price?: number
} }
import { DateTime } from 'luxon' import { DateTime } from 'luxon'
interface Onboarding {
isWelcomeSeen: boolean
}
export interface ProfileEntity { export interface ProfileEntity {
id: string id: string
/** Hash used to verify the content of ecogestures */
ecogestureHash: string ecogestureHash: string
/** Hash used to verify the content of challenges */
challengeHash: string challengeHash: string
/** Hash used to verify the content of duels */
duelHash: string duelHash: string
/** Hash used to verify the content of quiz */
quizHash: string quizHash: string
/** Hash used to verify the content of exploration */
explorationHash: string explorationHash: string
/** Boolean used to inform if the user connects for the first time */
isFirstConnection: boolean isFirstConnection: boolean
/** Date of the last user connection */
lastConnectionDate: string lastConnectionDate: string
/** Boolean used to inform if user has seen the last analysis */
haveSeenLastAnalysis: boolean haveSeenLastAnalysis: boolean
/** Boolean used to inform if user has seen the analysis notification */
sendAnalysisNotification: boolean sendAnalysisNotification: boolean
isAnalysisReminderEnabled: boolean isAnalysisReminderEnabled: boolean
/** Date of the last monthly analysis */
monthlyAnalysisDate: string monthlyAnalysisDate: string
sendConsumptionAlert: boolean sendConsumptionAlert: boolean
waterDailyConsumptionLimit: number waterDailyConsumptionLimit: number
/** Check if a user has completed his consumption profile */
isProfileTypeCompleted: boolean isProfileTypeCompleted: boolean
isProfileEcogestureCompleted: boolean isProfileEcogestureCompleted: boolean
onboarding: Onboarding onboarding: {
isWelcomeSeen: boolean
}
mailToken: string mailToken: string
partnersIssueSeenDate: { partnersIssueSeenDate: {
enedis?: string enedis?: string
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment