Member Junction
    Preparing search index...

    Server side cache of users and their roles.

    Uses BaseSingleton to guarantee a single instance across the entire process, even if bundlers duplicate this module across multiple execution paths.

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get GlobalKey(): string

      Returns string

    Methods

    • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

      Returns GlobalObjectStore

    • 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

      • OptionalautoRefreshIntervalMS: number

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

      Returns Promise<void>

    • 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

    • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

      Type Parameters

      Parameters

      • this: new () => T
      • OptionalclassName: string

      Returns T