Class User

Basic user representing the format of user data within this application.

Hierarchy

User

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new User(data?: object): User

- Defined in server/entities/user.entity.ts:29
Instanciates a new User and (optionally) hydrates with data

Parameters
- Default value data: object = {eppn: '',firstName: '',lastName: '',email: '',}
  - email: string
    
    The user's email address
  - eppn: string
    
    A unique ID identifying a user, provided by HarvardKey. Typically in the format of <random identifier>@harvard.edu
  - firstName: string
    
    The user's given (first) name
  - lastName: string
Returns User

Properties

email

email: string

User's email address

example: waldo@harvard.edu

eppn

eppn: string

Unique ID representing a user.

See HarvardKeyProfile.eppn for more information

firstName

firstName: string

User's first name

example: James

lastName

lastName: string

User's Last name

example: Waldo

Accessors

fullName

get fullName(): string

- Defined in server/entities/user.entity.ts:61
Get the user's name as firstName lastName

example

Jim Waldo

Returns string

listName

get listName(): string

- Defined in server/entities/user.entity.ts:69
Get the user's name as lastName, firstName

example

Waldo, Jim

Returns string

Generated using TypeDoc