spotify-types/typings/artist.d.ts

All the typings for the various Spotify API Object typings written in typescript.

import { ExternalUrl, Image, SpotifyType } from "./global";
import { Followers } from "./user";

/**
 * The structure containing the simplified details of the Spotify Artist.
 * 
 * @see https://developer.spotify.com/documentation/web-api/reference/#object-simplifiedartistobject
 */
export interface SimplifiedArtist {
    /** Known external URLs for this artist. */
    external_urls: ExternalUrl;
    /** A link to the Web API endpoint providing full details of the artist. */
    href: string;
    /** The Spotify ID for the artist. */
    id: string;
    /** The name of the artist. */
    name: string;
    /** The object type: "artist". */
    type: SpotifyType;
    /** The Spotify URI for the artist. */
    uri: string;
}

/**
 * The structure containing the entire details of the Spotify Artist.
 * 
 * @see https://developer.spotify.com/documentation/web-api/reference/#object-artistobject
 */
export interface Artist extends SimplifiedArtist {
    /** Information about the followers of the artist. */
    followers: Followers;
    /** A list of the genres the artist is associated with. For example: "Prog Rock" , "Post-Grunge". (If not yet classified, the array is empty.) */
    genres: string[];
    /** Images of the artist in various sizes, widest first. */
    images: Image[];
    /** The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist’s popularity is calculated from the popularity of all the artist’s tracks. */
    popularity: number;
}