BaseManager | tspotify

Base class for all managers

Type parameters

R
T: BaseStructure

Hierarchy

BaseManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BaseManager<R, T>(client: Client, structureType: StructureConstructable<T>): BaseManager<R, T>

- Defined in src/managers/BaseManager.ts:26
Type parameters
- R
- T: BaseStructure<T>
Parameters
- client: Client
  
  The client that instantiated this manager
- structureType: StructureConstructable<T>
  
  The type of structure held by this manager
Returns BaseManager<R, T>

Properties

Protected _holds

_holds: StructureConstructable<T>

The type of structure held by this manager

cache

cache: Collection<string, T>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Protected _search

_search(options: SearchOptions, type: SearchItemType, market?: string): Promise<GetSearchResponse>

- Defined in src/managers/BaseManager.ts:79
Searches Spotify

Parameters
- options: SearchOptions
  
  The options for searching
- type: SearchItemType
  
  The type of items to search
- Optional market: string
Returns Promise<GetSearchResponse>

add

add(id: string, cacheAfterFetching?: boolean, data: unknown): T

- Defined in src/managers/BaseManager.ts:68
Converts raw data sent by the API to a structure and adds it to the cache

Parameters
- id: string
  
  The ID of the structure
- cacheAfterFetching: boolean = true
  
  Whether to cache the structure or not
- data: unknown
  
  The raw data returned by the API for this structure
Returns T

resolve

resolve(idOrInstance: string | R): null | T

- Defined in src/managers/BaseManager.ts:46
Resolves a structure resolvable to its respective structure

Parameters
- idOrInstance: string | R
  
  The ID or instance of the structure held by this manager
Returns null | T

resolveID

resolveID(idOrInstance: string | R): null | string

- Defined in src/managers/BaseManager.ts:56
Resolves a structure resolvable to its id

Parameters
- idOrInstance: string | R
  
  The ID or instance of the strucutre held by this manager
Returns null | string

Generated using TypeDoc