TrackManager | tspotify

Hierarchy

BaseManager<TrackResolvable, Track>
- TrackManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TrackManager(client: Client): TrackManager

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

Properties

Protected _holds

_holds: StructureConstructable<Track>

The type of structure held by this manager

cache

cache: Collection<string, Track>

The cache of the structures held by this manager

client

client: Client

Client that instantiated this class

Methods

Private _fetchMany

_fetchMany(ids: string[], options?: FetchTracksOptions): Promise<Collection<string, Track>>

- Defined in src/managers/TrackManager.ts:98
Parameters
- ids: string[]
- Optional options: FetchTracksOptions
Returns Promise<Collection<string, Track>>

Private _fetchManyAudioFeatures

_fetchManyAudioFeatures(ids: string[], options?: FetchMultipleAudioFeaturesOptions): Promise<(null | AudioFeatures)[]>

- Defined in src/managers/TrackManager.ts:168
Parameters
- ids: string[]
- Optional options: FetchMultipleAudioFeaturesOptions
Returns Promise<(null | AudioFeatures)[]>

Private _fetchSingle

_fetchSingle(id: string, options?: FetchTrackOptions): Promise<Track>

- Defined in src/managers/TrackManager.ts:85
Parameters
- id: string
- Optional options: FetchTrackOptions
Returns Promise<Track>

Private _fetchSingleAudioFeatures

_fetchSingleAudioFeatures(id: string, options?: FetchSingleAudioFeaturesOptions): Promise<AudioFeatures>

- Defined in src/managers/TrackManager.ts:153
Parameters
- id: string
- Optional options: FetchSingleAudioFeaturesOptions
Returns Promise<AudioFeatures>

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): Track

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 Track

fetch

fetch<T>(options: T): Promise<null | FetchedTrack<T>>

- Defined in src/managers/TrackManager.ts:61
Fetches track(s) from Spotify

Type parameters
- T: TrackResolvable | FetchTrackOptions | FetchTracksOptions
Parameters
- options: T
Returns Promise<null | FetchedTrack<T>>

fetchAudioFeatures

fetchAudioFeatures<T>(options: T): Promise<null | FetchedAudioFeatures<T>>

- Defined in src/managers/TrackManager.ts:129
Fetches audio features of a track

Type parameters
- T: TrackResolvable | FetchSingleAudioFeaturesOptions | FetchMultipleAudioFeaturesOptions
Parameters
- options: T
  
  Options for fetching audio features of a track
Returns Promise<null | FetchedAudioFeatures<T>>

An AudioFeatures object or an array of AudioFeatures as a Promise

fetchRecommendations

fetchRecommendations(options: FetchRecommendationsOptions): Promise<Recommendation>

- Defined in src/managers/TrackManager.ts:205
Fetches recommended tracks on the basis of options provided

Parameters
- options: FetchRecommendationsOptions
  
  The options for fetching recommendations
Returns Promise<Recommendation>

A Recommendation object as a Promise

resolve

resolve(trackResolvable: TrackResolvable): null | Track

Overrides BaseManager.resolve
- Defined in src/managers/TrackManager.ts:38
Resolves a TrackResolvable to a Track object

Parameters
- trackResolvable: TrackResolvable
Returns null | Track

resolveID

resolveID(trackResolvable: TrackResolvable): null | string

Overrides BaseManager.resolveID
- Defined in src/managers/TrackManager.ts:49
Resolves a TrackResolvable to a Track ID

Parameters
- trackResolvable: TrackResolvable
Returns null | string

search

search(options: SearchTracksOptions): Promise<Page<TrackObject, Track>>

- Defined in src/managers/TrackManager.ts:282
Fetches tracks from Spotify by searching

Parameters
- options: SearchTracksOptions
  
  The options provided for searching tracks
Returns Promise<Page<TrackObject, Track>>

A Page of Track objects as a Promise

Generated using TypeDoc