SimplifiedArtist | tspotify

Hierarchy

BaseStructure
- SimplifiedArtist
  - Artist

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SimplifiedArtist(client: Client, data: SimplifiedArtistObject): SimplifiedArtist

Overrides BaseStructure.constructor
- Defined in src/structures/SimplifiedArtist.ts:36
Parameters
- client: Client
- data: SimplifiedArtistObject
Returns SimplifiedArtist

Properties

client

client: Client

The client that instantiated this class

externalUrls

externalUrls: ExternalUrl

Known external URLs for this artist

href

href: string

A link to the Web API endpoint providing full details of the artist

id

id: string

The Spotify ID of the structure

name

name: string

The name of the artist

rawObjectType

rawObjectType: string

The raw object type returned by the API: artist

uri

uri: string

The Spotify URI for the artist

Methods

fetchAlbums

fetchAlbums(options?: FetchArtistAlbumsOptions): Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

- Defined in src/structures/SimplifiedArtist.ts:74
Fetches albums of the artist

Parameters
- Optional options: FetchArtistAlbumsOptions
  
  Options for fetching the albums
Returns Promise<Page<SimplifiedAlbumObject, SimplifiedAlbum>>

A Page of SimplifiedAlbum objects as a Promise

fetchRelatedArtist

fetchRelatedArtist(): Promise<Collection<string, Artist>>

- Defined in src/structures/SimplifiedArtist.ts:65
Fetches artists similar to the artist

Returns Promise<Collection<string, Artist>>

A collection of Artist objects as a Promise

fetchTopTracks

fetchTopTracks(market: string): Promise<Collection<string, Track>>

- Defined in src/structures/SimplifiedArtist.ts:57
Fetches top ten tracks of the artist from a given market

Parameters
- market: string
  
  The market to consider for the top tracks
Returns Promise<Collection<string, Track>>

A collection of Track objects as a Promise

Generated using TypeDoc