Interface IUserInfoCache

Interface that should follow a class to implement cache for user data.

interface IUserInfoCache {
    clear(): Promise<void>;
    get(id): Promise<null | FiefUserInfo>;
    remove(id): Promise<void>;
    set(id, userinfo): Promise<void>;
}

Methods

  • Clear all the user information from cache.

    Returns Promise<void>

  • Retrieve user information from cache, if available.

    Parameters

    • id: string

      ID of the user to retrieve the user information for.

    Returns Promise<null | FiefUserInfo>

    User information or null.

  • Remove user information from cache.

    Parameters

    • id: string

      ID of the user to remove the user information for.

    Returns Promise<void>

  • Store user information in cache.

    Parameters

    • id: string

      ID of the user to store user information for.

    • userinfo: FiefUserInfo

      The user information to store.

    Returns Promise<void>