Class BotUsersController

Provides an interface for the bot's users cache. The users are mapped by their IDs

Hierarchy

BaseFetchController<User>
- BotUsersController

Index

Constructors

constructor

Properties

cache

Methods

Constructors

constructor

new BotUsersController(bot: Bot): BotUsersController

Overrides BaseController.constructor
- Defined in src/controllers/bot/BotUsersController.ts:10
Parameters
- bot: Bot
Returns BotUsersController

Properties

cache

cache: ControllerCache<User>

The cached data this controller contains

Methods

fetch

fetch(id: Snowflake): Promise<User>

Overrides BaseFetchController.fetch
- Defined in src/controllers/bot/BotUsersController.ts:38
Fetches a user by its ID

Parameters
- id: Snowflake
  
  The user ID
Returns Promise<User>

fetchBot

fetchBot(): Promise<BotUser>

- Defined in src/controllers/bot/BotUsersController.ts:19
Fetches the bot user

Returns Promise<BotUser>

get

get(id: Snowflake | string): Promise<User>

Inherited from BaseFetchController.get
- Defined in src/controllers/base/BaseFetchController.ts:22
Returns an already cached item or fetches it

Parameters
- id: Snowflake | string
  
  The ID of the item you wish to get or fetch
Returns Promise<User>

Generated using TypeDoc