Options
All
  • Public
  • Public/Protected
  • All
Menu

Module orm_functions/login_user

Index

Functions

Functions

createLoginUser

deleteLoginUserById

  • deleteLoginUserById(loginUserId: number): Promise<login_user & { person: person }>

  • Parameters

    • loginUserId: number

      the login user who's info we are deleting from the login user-table

    Returns Promise<login_user & { person: person }>

    personal info about the login user, this info can be used to further remove the person

deleteLoginUserByPersonId

  • deleteLoginUserByPersonId(personId: number): Promise<login_user & { person: person }>

  • Parameters

    • personId: number

      the login user who's info we are deleting from the login user-table

    Returns Promise<login_user & { person: person }>

    personal info about the login user, this info can be used to further remove the person

deleteLoginUserFromDB

  • deleteLoginUserFromDB(loginUserId: number): Promise<void>

filterLoginUsers

  • Parameters

    • pagination: DBPagination
    • nameFilter: FilterString = undefined

      name that we are filtering on (or undefined if not filtering on name)

    • emailFilter: FilterString = undefined

      email that we are filtering on (or undefined if not filtering on email)

    • nameSort: FilterSort = undefined

      asc or desc if we want to sort on name, undefined if we are not sorting on name

    • emailSort: FilterSort = undefined

      asc or desc if we are sorting on email, undefined if we are not sorting on email

    • statusFilter: undefined | account_status_enum = undefined

      a given email status to filter on or undefined if we are not filtering on a status

    • isCoach: FilterBoolean = undefined
    • isAdmin: FilterBoolean = undefined

    Returns Promise<{ data: (login_user & { person: person })[]; pagination: { count: number; page: number } }>

    the filtered loginUsers with their person data in a promise

getAllLoginUsers

  • getAllLoginUsers(): Promise<(login_user & { person: person })[]>

getLoginUserById

  • getLoginUserById(loginUserId: number): Promise<null | (login_user & { person: person })>

  • Parameters

    • loginUserId: number

    Returns Promise<null | (login_user & { person: person })>

    promise with the found data, or promise with null inside if no loginUser has the given id

getOsocYearsForLoginUser

  • getOsocYearsForLoginUser(loginUserId: number): Promise<number[]>

  • get a list of years that should be visible for the login_user with given id

    Parameters

    • loginUserId: number

    Returns Promise<number[]>

getPasswordLoginUser

  • getPasswordLoginUser(loginUserId: number): Promise<null | { password: null | string }>
  • returns:

    password of the login user object

    Parameters

    • loginUserId: number

    Returns Promise<null | { password: null | string }>

getPasswordLoginUserByPerson

  • getPasswordLoginUserByPerson(personId: number): Promise<null | { password: null | string }>
  • returns:

    password of the login user object

    Parameters

    • personId: number

    Returns Promise<null | { password: null | string }>

searchAllAdminAndCoachLoginUsers

  • searchAllAdminAndCoachLoginUsers(bool: boolean): Promise<(login_user & { person: person })[]>
  • returns:

    all login user objects where the bool matches with both the admin and coach status

    Parameters

    • bool: boolean

    Returns Promise<(login_user & { person: person })[]>

searchAllAdminLoginUsers

  • searchAllAdminLoginUsers(isAdmin: boolean): Promise<(login_user & { person: person })[]>
  • returns:

    all login user objects that match with the admin status

    Parameters

    • isAdmin: boolean

    Returns Promise<(login_user & { person: person })[]>

searchAllCoachLoginUsers

  • searchAllCoachLoginUsers(isCoach: boolean): Promise<(login_user & { person: person })[]>
  • returns:

    all login user objects that match with the coach status

    Parameters

    • isCoach: boolean

    Returns Promise<(login_user & { person: person })[]>

searchLoginUserByPerson

  • searchLoginUserByPerson(personId: number): Promise<null | (login_user & { person: person })>
  • returns:

    login user object

    Parameters

    • personId: number

    Returns Promise<null | (login_user & { person: person })>

setAdmin

  • setAdmin(loginUserId: number, isAdmin: boolean): Promise<login_user & { person: person }>

  • Sets the is_admin field of the loginuser to IsAdmin

    Parameters

    • loginUserId: number

      the id of the loginUser whose field we are updating

    • isAdmin: boolean

      the new value of is_admin

    Returns Promise<login_user & { person: person }>

    a promise with the updated entry, the person object is also included

setCoach

  • setCoach(loginUserId: number, isCoach: boolean): Promise<login_user & { person: person }>

  • Sets the is_coach field of the loginUser to isCoach

    Parameters

    • loginUserId: number
    • isCoach: boolean

    Returns Promise<login_user & { person: person }>

    a promise with the updated entry, the person object is also included

updateLoginUser

  • updateLoginUser(loginUser: UpdateLoginUser): Promise<login_user & { person: person }>

Generated using TypeDoc