CategoryManager | tspotify

Hierarchy

BaseManager<CategoryResolvable, Category>
- CategoryManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CategoryManager(client: Client): CategoryManager

Overrides BaseManager.constructor
- Defined in src/managers/CategoryManager.ts:23
Parameters
- client: Client
Returns CategoryManager

Properties

Protected _holds

_holds: StructureConstructable<Category>

The type of structure held by this manager

cache

cache: Collection<string, Category>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchMultiple

_fetchMultiple(options?: FetchCategoriesOptions): Promise<Page<CategoryObject, Category>>

- Defined in src/managers/CategoryManager.ts:64
Parameters
- Optional options: FetchCategoriesOptions
Returns Promise<Page<CategoryObject, Category>>

Private _fetchSingle

_fetchSingle(id: string, options?: FetchCategoryOptions): Promise<Category>

- Defined in src/managers/CategoryManager.ts:50
Parameters
- id: string
- Optional options: FetchCategoryOptions
Returns Promise<Category>

Protected _search

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

Inherited from BaseManager._search
- 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): Category

Inherited from BaseManager.add
- 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 Category

fetch

fetch<T>(options: T): Promise<FetchedCategory<T>>

- Defined in src/managers/CategoryManager.ts:33
Fetches one or more categories from Spotify

Type parameters
- T: CategoryResolvable | FetchCategoryOptions | FetchCategoriesOptions
Parameters
- options: T
  
  Options for fetching categories
Returns Promise<FetchedCategory<T>>

A Category or a Page of Category objects as a Promise

fetchPlaylists

fetchPlaylists(categoryResolvable: CategoryResolvable, options?: FetchCategoryPlaylistsOptions): Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

- Defined in src/managers/CategoryManager.ts:82
Fetches playlists listed under a specific category

Parameters
- categoryResolvable: CategoryResolvable
  
  The category from which playlists are to be fetched
- Optional options: FetchCategoryPlaylistsOptions
  
  Options for fetching the playlists
Returns Promise<Page<SimplifiedPlaylistObject, SimplifiedPlaylist>>

A Page of SimplifiedPlaylist objects as a Promise

resolve

resolve(idOrInstance: CategoryResolvable): null | Category

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

Parameters
- idOrInstance: CategoryResolvable
  
  The ID or instance of the structure held by this manager
Returns null | Category

resolveID

resolveID(idOrInstance: CategoryResolvable): null | string

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

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

Generated using TypeDoc