Class UserManager

The manager of users that belong to the client.

Example

new UserManager(client);

Hierarchy

Constructors

constructor

Properties

cache client

Methods

fetch setMaxCache

Constructors

constructor

Properties

Readonly cache

cache: CacheCollection<string, User>

This cache of the manager.

Readonly client

client: Client

Methods

fetch

  • Fetch a user from a server, or cache.

    Returns

    The fetched user.

    Example

    users.fetch(server, user);

    Parameters

    • server: string | Server

      The server the user belongs to.

    • user: string | User

      The user to fetch.

    Returns Promise<User>

  • Fetch users from a server.

    Returns

    The fetched users.

    Example

    users.fetch(server);

    Parameters

    • server: string | Server

      The server the users belong to.

    Returns Promise<Collection<string, User>>

setMaxCache

  • Set the maximum cache size of the manager.

    Returns

    The manager.

    Example

    manager.setMaxCache(100);

    Parameters

    • maxSize: number

      The maximum size of the cache.

    Returns UserManager

Settings

Member Visibility

Theme