Class UserManager

Hierarchy (View Summary)

BaseManager<User, ApiUser>
- UserManager

Index

Constructors

constructor

new UserManager(
    client: TelegramClient | BaseClient,
    iterable: User[],
    options?: ICachedOptions<User>,
): UserManager
Parameters
- client: TelegramClient | BaseClient
  The client instance.
- iterable: User[]
  Data iterable.
- Optionaloptions: ICachedOptions<User>
  Options for save cached.
Returns UserManager
Overrides BaseManager.constructor

Properties

`Readonly`cache

cache: Collection<string, User>

`Optional` `Readonly`cacheFilter

cacheFilter?: (holds: User) => boolean

`Readonly`cacheSize

cacheSize: number

Accessors

client

get client(): TelegramClient | BaseClient
The client that instantiated this

Returns TelegramClient | BaseClient
Inherited from BaseManager.client

Methods

_add

_add(
    data: User,
    cache?: boolean,
    options?: { 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
- Optionaloptions: { extras?: unknown[]; id?: string }
  Additional options.
Returns User
The cached or newly created entry.

Inherited from BaseManager._add

[iterator]

"[iterator]"(): IterableIterator<[string, User]>
Returns a new Iterator object that contains the [key, value] pairs for each element in the collection.

Returns IterableIterator<[string, User]>
An iterator object that can be used to iterate over the key-value pairs of the Collection.

Inherited from BaseManager.[iterator]

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
- user: string | Message | ChatMember
  The ChatMember, Message, or user ID to fetch.
- Optionaloptions: IFetchOptions
  Options for fetching.
Returns Promise<ChatFullInfo | User>
The fetched User or ChatFullInfo instance.

fetchMany

fetchMany(
users: UserResolvable[],
options?: Omit<IFetchOptions, "fullInfo"> & { fullInfo?: false },
): Promise<(User | null)[]>
Fetches multiple users at once.
Parameters
- users: UserResolvable[]
  Array of users to fetch.
- Optionaloptions: Omit<IFetchOptions, "fullInfo"> & { fullInfo?: false }
  Options for fetching.
Returns Promise<(User | null)[]>
Array of fetched users (nulls for failed fetches).
fetchMany(
users: UserResolvable[],
options?: Omit<IFetchOptions, "fullInfo"> & { fullInfo: true },
): Promise<(ChatFullInfo | null)[]>
Fetches multiple users at once.
Parameters
- users: UserResolvable[]
  Array of users to fetch.
- Optionaloptions: Omit<IFetchOptions, "fullInfo"> & { fullInfo: true }
  Options for fetching.
Returns Promise<(ChatFullInfo | null)[]>
Array of fetched users (nulls for failed fetches).
fetchMany(
users: UserResolvable[],
options?: IFetchOptions,
): Promise<(ChatFullInfo | User | null)[]>
Fetches multiple users at once.
Parameters
- users: UserResolvable[]
  Array of users to fetch.
- Optionaloptions: IFetchOptions
  Options for fetching.
Returns Promise<(ChatFullInfo | User | null)[]>
Array of fetched users (nulls for failed fetches).

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.

Inherited from BaseManager.remove

resolve

resolve(user: UserResolvable): User | null
Resolves a user from a ChatMember, Message, User or user ID.
Parameters
- user: UserResolvable
  The ChatMember, Message, User or user ID to resolve.
Returns User | null
The resolved User instance or null if not found.

Overrides BaseManager.resolve

resolveId

resolveId(user: any): string | null
Resolves the user ID from a ChatMember, Message, User or user ID.
Parameters
- user: any
  The ChatMember, Message, User or user ID to resolve.
Returns string | null
The resolved user ID or null if not found.

Overrides BaseManager.resolveId

Class UserManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns UserManager

Properties

Readonlycache

Optional ReadonlycacheFilter

ReadonlycacheSize

Accessors

client

Returns TelegramClient | BaseClient

Methods

_add

Parameters

Returns User

[iterator]

Returns IterableIterator<[string, User]>

fetch

Parameters

Returns Promise<User>

Parameters

Returns Promise<ChatFullInfo>

Parameters

Returns Promise<ChatFullInfo | User>

fetchMany

Parameters

Returns Promise<(User | null)[]>

Parameters

Returns Promise<(ChatFullInfo | null)[]>

Parameters

Returns Promise<(ChatFullInfo | User | null)[]>

remove

Parameters

Returns boolean

resolve

Parameters

Returns User | null

resolveId

Parameters

Returns string | null

Settings

On This Page

`Readonly`cache

`Optional` `Readonly`cacheFilter

`Readonly`cacheSize