TSpotify

A Node.js and TypeScript library for interacting with Spotify API.

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AlbumResolvable

AlbumResolvable: string | BaseAlbum | SimplifiedAlbum | Album

ArtistResolvable

ArtistResolvable: string | SimplifiedArtist | Artist

CategoryResolvable

CategoryResolvable: string | Category

EpisodeResolvable

EpisodeResolvable: string | SimplifiedEpisode | Episode

FetchedAlbum

FetchedAlbum<T>: T extends AlbumResolvable | FetchAlbumOptions ? Album : Collection<string, Album>

Type parameters

T: AlbumResolvable | FetchAlbumOptions | FetchAlbumsOptions

FetchedArtist

FetchedArtist<T>: T extends ArtistResolvable | FetchArtistOptions ? Artist : Collection<string, Artist>

Type parameters

T: ArtistResolvable | FetchArtistOptions | FetchArtistsOptions

FetchedAudioFeatures

FetchedAudioFeatures<T>: T extends TrackResolvable | FetchSingleAudioFeaturesOptions ? AudioFeatures : AudioFeatures[]

Type parameters

T: TrackResolvable | FetchSingleAudioFeaturesOptions | FetchMultipleAudioFeaturesOptions

FetchedCategory

FetchedCategory<T>: T extends CategoryResolvable | FetchCategoryOptions ? Category : Page<CategoryObject, Category>

Type parameters

T: CategoryResolvable | FetchCategoryOptions | FetchCategoriesOptions

FetchedEpisode

FetchedEpisode<T>: T extends FetchEpisodeOptions ? Episode : Collection<string, Episode>

Type parameters

T: FetchEpisodeOptions | FetchEpisodesOptions

FetchedShow

FetchedShow<T>: T extends FetchShowOptions ? Show : Collection<string, SimplifiedShow>

Type parameters

T: FetchShowOptions | FetchShowsOptions

FetchedTrack

FetchedTrack<T>: T extends TrackResolvable | FetchTrackOptions ? Track : Collection<string, Track>

Type parameters

T: TrackResolvable | FetchTrackOptions | FetchTracksOptions

PlaylistResolvable

PlaylistResolvable: string | BasePlaylist | SimplifiedPlaylist | Playlist

SearchItemType

SearchItemType: "album" | "artist" | "episode" | "playlist" | "show" | "track"

SeedResolvable

SeedResolvable: ArtistResolvable | string | TrackResolvable

SeedType

SeedType: "ARTIST" | "GENRE" | "TRACK"

ShowResolvable

ShowResolvable: string | SimplifiedShow | Show

SubdomainType

SubdomainType: "api" | "account"

TrackResolvable

TrackResolvable: string | SimplifiedTrack | Track

UserResolvable

UserResolvable: string | PublicUser | PrivateUser

Variables

CustomError

CustomError: any

CustomRangeError

CustomRangeError: any

CustomTypeError

CustomTypeError: any

Const DefaultClientOptions

DefaultClientOptions: ClientOptions = ...

The default options with which the client gets initiated

Const Events

Events: { ACCESS_TOKEN_UPDATE: string; READY: string } = ...

Object that holds all the client events

Type declaration

ACCESS_TOKEN_UPDATE: string
READY: string

Functions

mergeDefault

mergeDefault(defaultObject: any, given: any): ClientOptions

- Defined in src/util/Util.ts:7
Parameters
- defaultObject: any
- given: any
Returns ClientOptions

parseResponse

parseResponse(res: Response): Promise<any>

- Defined in src/util/Util.ts:25
Parses an API response and returns the body

Parameters
- res: Response
  
  The response sent by the API
Returns Promise<any>

The body of the response

Generated using TypeDoc