Class Album

To work with Deezer album objects.

See

the Deezer Album API Documentation for more details about each field.

Hierarchy (View Summary)

Constructors

constructor

Properties

title upc? link? share? cover cover_small cover_medium cover_big cover_xl md5_image genre_id? genres? label? nb_tracks? duration? fans? release_date? record_type? available? alternative? tracklist explicit_lyrics? explicit_content_lyrics? explicit_content_cover? contributors? artist? tracks? role? client _fields _fetched id type

Methods

getArtist getTracks toJSON getRelation getPaginatedList ensureField get

Constructors

constructor

Properties

title

title: string

Optionalupc

upc?: string

Optionallink

link?: string

Optionalshare

share?: string

cover

cover: string

cover_small

cover_small: string

cover_medium

cover_medium: string

cover_big

cover_big: string

cover_xl

cover_xl: string

md5_image

md5_image: string

Optionalgenre_id

genre_id?: number

Optionalgenres

genres?: Genre[]

Optionallabel

label?: string

Optionalnb_tracks

nb_tracks?: number

Optionalduration

duration?: number

Optionalfans

fans?: number

Optionalrelease_date

release_date?: null | Date

Optionalrecord_type

record_type?: string

Optionalavailable

available?: boolean

Optionalalternative

alternative?: Album

tracklist

tracklist: string

Optionalexplicit_lyrics

explicit_lyrics?: boolean

Optionalexplicit_content_lyrics

explicit_content_lyrics?: number

Optionalexplicit_content_cover

explicit_content_cover?: number

Optionalcontributors

contributors?: Artist[]

Optionalartist

artist?: Artist

Optionaltracks

tracks?: Track[]

Optionalrole

role?: string

Protected Readonlyclient

client: Client

Protected_fields

_fields: string[]

Protected_fetched

_fetched: boolean = false

id

id: number

type

type: string

Methods

getArtist

getTracks

toJSON

getRelation

  • getRelation<T>(
        relation: string,
        resourceType?: new (client: Client, json: Record<string, any>) => Resource,
        params?: Record<string, string>,
        fwdParent?: boolean,
    ): Promise<T>

    Type Parameters

    • T

    Parameters

    • relation: string
    • OptionalresourceType: new (client: Client, json: Record<string, any>) => Resource
    • Optionalparams: Record<string, string>
    • fwdParent: boolean = true

    Returns Promise<T>

getPaginatedList

ProtectedensureField

  • ensureField<T>(fieldName: string): Promise<T>

    Ensures a field is loaded, fetching the full resource if necessary.

    Type Parameters

    • T

    Parameters

    • fieldName: string

      The name of the field to ensure

    Returns Promise<T>

    The value of the field

    Throws

    Error if the field cannot be loaded

get

Settings

Member Visibility

On This Page

Constructors
Properties
Methods