Class UserCache

constructor

• new UserCache(): UserCache

• Returns UserCache

Static _instance

SYSTEM_USER_ID

• get SYSTEM_USER_ID(): string

• Returns string

Users

• get Users(): UserInfo[]

• Returns UserInfo[]

Static Instance

• get Instance(): UserCache

• Returns UserCache

Static Users

• get Users(): UserInfo[]

• Returns UserInfo[]

GetSystemUser

• GetSystemUser(): UserInfo

• Returns UserInfo

Refresh

• Refresh(pool, autoRefreshIntervalMS?): Promise<void>

• This method will refresh the cache with the latest data from the database

  Parameters

  • pool: ConnectionPool

    the connection pool to use to refresh the cache
  • Optional autoRefreshIntervalMS: number

    optional, if provided, the cache will be refreshed every interval as specified - denominated in milliseconds

  Returns Promise<void>

UserByName

• UserByName(name, caseSensitive?): UserInfo

• Convenience method to get a user by their name

  Parameters

  • name: string

    name of the user
  • caseSensitive: boolean = false

    optional, if true, the search will be case sensitive

  Returns UserInfo