Class BaseFetchController<T>

Base controller with fetch capabilities

Type parameters

T: BaseStructWithId

Hierarchy

BaseController<T>
- BaseFetchController

Index

Constructors

constructor

Properties

cache

Methods

fetch
get

Constructors

constructor

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

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

Properties

cache

cache: ControllerCache<T>

The cached data this controller contains

Methods

Abstract fetch

fetch(id: Snowflake | string): Promise<T>

- Defined in src/controllers/base/BaseFetchController.ts:15
Fetches a new item and caches it

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

get

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

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

Generated using TypeDoc