Class BotGuildsController

Interface for the bot's guilds cache. The guilds are mapped by their IDs

Hierarchy

BaseFetchController<Guild>
- BotGuildsController

Index

Constructors

constructor

Properties

cache

Methods

Constructors

constructor

new BotGuildsController(struct: BaseStruct | Bot, limit?: undefined | number): BotGuildsController

Inherited from BaseController.constructor
- Defined in src/controllers/base/BaseController.ts:18
Parameters
- struct: BaseStruct | Bot
- Optional limit: undefined | number
Returns BotGuildsController

Properties

cache

cache: ControllerCache<Guild>

The cached data this controller contains

Methods

fetch

fetch(id: Snowflake, options?: FetchGuildOptions): Promise<Guild>

Overrides BaseFetchController.fetch
- Defined in src/controllers/bot/BotGuildsController.ts:29
Fetches a guild by its ID and caches it

Parameters
- id: Snowflake
  
  The ID of the guild
- Optional options: FetchGuildOptions
  
  The additional options for the fetch operation
Returns Promise<Guild>

fetchPreview

fetchPreview(id: Snowflake): Promise<GuildPreview>

- Defined in src/controllers/bot/BotGuildsController.ts:42
Fetches a guild preview by its guild ID

Parameters
- id: Snowflake
  
  The ID of the guild
Returns Promise<GuildPreview>

get

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

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<Guild>

Generated using TypeDoc