Interface IUserInfoCacheProvider

Provider for caching user information to optimize repeated lookups.

interface IUserInfoCacheProvider {
    clear(): Promise<void>;
    getUserInfo(id: string, type?: null | string): Promise<null | IUserInfo>;
    getUsersInfo(ids: string[], type?: null | string): Promise<IUserInfo[]>;
    setUserInfo(info: IUserInfo, type?: null | string): Promise<void>;
    setUsersInfo(info: IUserInfo[], type?: null | string): Promise<void>;
}

Implemented by

Methods

clear getUserInfo getUsersInfo setUserInfo setUsersInfo

Methods

clear

  • clear(): Promise<void>

    Clears all cached user information.

    Returns Promise<void>

getUserInfo

  • getUserInfo(id: string, type?: null | string): Promise<null | IUserInfo>

    Retrieves cached user information for single user with specified identifier.

    Parameters

    • id: string

      The user identifier.

    • Optionaltype: null | string

      Optional user info handler type. If null, the default handler is used.

    Returns Promise<null | IUserInfo>

    User information or null user not found by identifier.

getUsersInfo

  • getUsersInfo(ids: string[], type?: null | string): Promise<IUserInfo[]>

    Retrieves cached user information for multiple users with specified identifiers.

    Parameters

    • ids: string[]

      A collection of the user identifiers.

    • Optionaltype: null | string

      Optional user info handler type. If null, the default handler is used.

    Returns Promise<IUserInfo[]>

    A collection of user information for users that are found.

setUserInfo

  • setUserInfo(info: IUserInfo, type?: null | string): Promise<void>

    Caches a single user information object.

    Parameters

    • info: IUserInfo

      Basic user information.

    • Optionaltype: null | string

      Optional user info handler type. If null, the default handler is used.

    Returns Promise<void>

setUsersInfo

  • setUsersInfo(info: IUserInfo[], type?: null | string): Promise<void>

    Caches multiple user information objects.

    Parameters

    • info: IUserInfo[]

      A collection of basic user informations.

    • Optionaltype: null | string

      Optional user info handler type. If null, the default handler is used.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Methods