Class UserManager

Hierarchy (View Summary)

Constructors

constructor

Properties

cache cacheFilter? cacheSize

Accessors

client

Methods

_add [iterator] fetch remove resolve resolveId

Constructors

constructor

Properties

Readonlycache

cache: Collection<string, User>

Optional ReadonlycacheFilter

cacheFilter?: (holds: User) => boolean

ReadonlycacheSize

cacheSize: number

Accessors

client

Methods

_add

  • _add(
        data: User,
        cache?: boolean,
        __namedParameters?: { extras?: unknown[]; id?: string },
    ): User

  • Adds or updates an entry in the cache.

    Parameters

    • data: User

      The data to be added or updated in the cache.

    • Optionalcache: boolean
    • Optional__namedParameters: { extras?: unknown[]; id?: string }

    Returns User

    The cached or newly created entry.

[iterator]

  • "[iterator]"(): IterableIterator<[string, User], any, any>

  • Returns a new Iterator object that contains the [key, value] pairs for each element in the collection.

    Returns IterableIterator<[string, User], any, any>

    An iterator object that can be used to iterate over the key-value pairs of the Collection.

fetch

  • fetch(
        user: string | Message | ChatMember,
        options?: Omit<IFetchOptions, "fullInfo"> & { fullInfo?: false },
    ): Promise<User>

  • Fetches a user by ID, optionally caching the result.

    Parameters

    • user: string | Message | ChatMember

      The ChatMember, Message, or user ID to fetch.

    • Optionaloptions: Omit<IFetchOptions, "fullInfo"> & { fullInfo?: false }

      Options for fetching.

    Returns Promise<User>

    The fetched User instance.

  • fetch(
        user: string | Message | ChatMember,
        options?: Omit<IFetchOptions, "fullInfo"> & { fullInfo: true },
    ): Promise<ChatFullInfo>

  • Fetches a user by ID, optionally caching the result.

    Parameters

    • user: string | Message | ChatMember

      The ChatMember, Message, or user ID to fetch.

    • Optionaloptions: Omit<IFetchOptions, "fullInfo"> & { fullInfo: true }

      Options for fetching.

    Returns Promise<ChatFullInfo>

    The fetched ChatFullInfo instance.

  • fetch(
        user: string | Message | ChatMember,
        options?: IFetchOptions,
    ): Promise<ChatFullInfo | User>

  • Fetches a user by ID, optionally caching the result.

    Parameters

    Returns Promise<ChatFullInfo | User>

    The fetched User or ChatFullInfo instance.

remove

  • remove(id: string): boolean

  • Removes an entry from the cache.

    Parameters

    • id: string

      The ID of the entry to remove.

    Returns boolean

    Whether the entry was successfully removed.

resolve

  • resolve(user: string | Message | ChatMember): null | User

  • Resolves a user from a ChatMember, Message, or user ID.

    Parameters

    Returns null | User

    The resolved User instance or null if not found.

resolveId

  • resolveId(user: string | Message | ChatMember): null | string

  • Resolves the user ID from a ChatMember, Message, or user ID.

    Parameters

    Returns null | string

    The resolved user ID or null if not found.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods