Source: borzoo/user.model.js

  1. import { List } from './list.model';
  3. // @flow
  4. /**
  5.  * A Zevere user account.
  6.  * @type User
  7.  */
  8. export type User = {
  9.     /**
  10.      * Number of days since this user has joined.
  11.      * @type {number}
  12.      * @memberof User
  13.      */
  14.     daysJoined: number,
  16.     /**
  17.      * First Name of this user.
  18.      * @type {string}
  19.      * @memberof User
  20.      */
  21.     firstName: string,
  23.     /**
  24.      * The user's username.
  25.      * @type {string}
  26.      * @memberof User
  27.      */
  28.     id: string,
  30.     /**
  31.      * The date account was created in UTC format.
  32.      *
  33.      * __Must be an ISO 8601 date string.__
  34.      * 
  35.      * Example: 2018-11-07
  36.      * @see https://en.wikipedia.org/wiki/ISO_8601
  37.      * @type {string}
  38.      * @memberof User
  39.      */
  40.     joinedAt: string,
  42.     /**
  43.      * The user's last name.
  44.      * @optional
  45.      * @type {string}
  46.      * @memberof User
  47.      */
  48.     lastName?: string,
  50.     /**
  51.      * The task lists that this user has access to.
  52.      * @optional
  53.      * @type {List[]}
  54.      * @memberof User
  55.      */
  56.     lists?: List[],
  57.     
  58.     /**
  59.      * Authentication token.
  60.      * @optional
  61.      * @type {string}
  62.      * @memberof User
  63.      */
  64.     token?: string
  65. };