Documentation / @imvu/client / BaseController

Class: BaseController<TResource, TParams, TResponse>

Defined in: packages/client/src/controllers/BaseController.ts:7

Type Parameters

Type Parameter	Default type
TResource extends Resource | object	Record<string, any>
TParams extends Record<string, any>	Record<string, any>
TResponse	TResource extends Resource ? TResource : APIResource<TResource>

Constructors

Constructor

new BaseController<TResource, TParams, TResponse>(
   client, 
   base, 
   model?
): BaseController<TResource, TParams, TResponse>;

Defined in: packages/client/src/controllers/BaseController.ts:12

Parameters

Parameter	Type
client	Client
base	string
model?	Constructor<TResource>

Returns

BaseController<TResource, TParams, TResponse>

Properties

base

protected readonly base: string;

Defined in: packages/client/src/controllers/BaseController.ts:14

---

client

protected readonly client: Client;

Defined in: packages/client/src/controllers/BaseController.ts:13

---

model?

protected readonly model?: Constructor<TResource>;

Defined in: packages/client/src/controllers/BaseController.ts:15

Methods

fetch()

fetch(id, options?): Promise<TResponse | null>;

Defined in: packages/client/src/controllers/BaseController.ts:23

Retrieve instances of resource from IMVU's API This is a lot faster than searching, so fetch with an ID if you can.

Parameters

Parameter	Type	Description
id	string | number	Request ID
options?	FetchOptions	-

Returns

Promise<TResponse | null>

---

resolve()

resolve(id): TResponse | undefined;

Defined in: packages/client/src/controllers/BaseController.ts:35

The cached instance for an id, without any request (undefined if not cached or no longer fresh). The equivalent of discord.js manager.cache.get(id).

Parameters

Parameter	Type
id	string | number

Returns

TResponse | undefined

---

search()

search(params): Promise<TResponse[]>;

Defined in: packages/client/src/controllers/BaseController.ts:46

Search for and retrieve objects based on a given query

Parameters

Parameter	Type	Description
params	TParams	Request query parameters to search for

Returns

Promise<TResponse[]>