guilded.ts
Version:
A powerful NPM module that allows you to easily interact with the Guilded API.
34 lines • 1.17 kB
TypeScript
import { Client } from '../structures/Client';
import { CacheCollection } from '../structures/CacheCollection';
/**
* The manager of a Guilded data model.
* @example new BaseManager(client);
*/
export declare class BaseManager<K = void, V = void> {
readonly client: Client;
/** This cache of the manager. */
readonly cache: CacheCollection<K, V>;
/**
* @param client The client the manager belongs to.
* @param maxCache The maximum cache size of the manager.
*/
constructor(client: Client, maxCache?: number);
/**
* Set the maximum cache size of the manager.
* @param maxSize The maximum size of the cache.
* @returns The manager.
* @example manager.setMaxCache(100);
*/
setMaxCache(maxSize: number): this;
}
/** The options for fetching data from Guilded. */
export interface FetchOptions extends FetchManyOptions {
/** The whether to force fetch the data. */
force?: boolean;
}
/** The options for fetching multiple data from Guilded. */
export interface FetchManyOptions {
/** The whether to cache the fetched data. */
cache?: boolean;
}
//# sourceMappingURL=BaseManager.d.ts.map