Class Editorial

To work with Deezer editorial objects.

See

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

Hierarchy (View Summary)

Resource
- Editorial

Index

Constructors

Properties

name picture picture_small picture_medium picture_big picture_xl client _fields _fetched id type

Methods

getSelection getChart getReleases toJSON getRelation getPaginatedList ensureField get

Constructors

constructor

new Editorial(client: Client, json: Record<string, any>): Editorial
Parameters
- client: Client
- json: Record<string, any>
Returns Editorial
Inherited from Resource.constructor
- Defined in src/resources/resource.ts:19

Properties

name

name: string

picture

picture: string

picture_small

picture_small: string

picture_medium

picture_medium: string

picture_big

picture_big: string

picture_xl

picture_xl: string

`Protected` `Readonly`client

client: Client

`Protected`_fields

_fields: string[]

`Protected`_fetched

_fetched: boolean = false

id

id: number

type

type: string

Methods

getSelection

getSelection(): Promise<Album[]>
Get a list of albums selected every week by the Deezer Team.

Returns Promise<Album[]>
- list of Album instances.
- Defined in src/resources/editorial.ts:28

getChart

getChart(): Promise<Chart>
Get top charts for tracks, albums, artists and playlists.

Returns Promise<Chart>
- a Chart instances.
- Defined in src/resources/editorial.ts:37

getReleases

getReleases(params: Record<string, string>): Promise<PaginatedList<Album>>
Get the new releases per genre for the current country.
Parameters
- params: Record<string, string>
Returns Promise<PaginatedList<Album>>
- a PaginatedList of Album instances.
- Defined in src/resources/editorial.ts:46

toJSON

toJSON(): Record<string, any>
Returns Record<string, any>
Inherited from Resource.toJSON
- Defined in src/resources/resource.ts:33

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>
Inherited from Resource.getRelation
- Defined in src/resources/resource.ts:55

getPaginatedList

getPaginatedList<T extends Resource>(
relation: string,
params?: Record<string, string>,
): PaginatedList<T>
Type Parameters
- T extends Resource
Parameters
- relation: string
- Optionalparams: Record<string, string>
Returns PaginatedList<T>
Inherited from Resource.getPaginatedList
- Defined in src/resources/resource.ts:73

`Protected`ensureField

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
Inherited from Resource.ensureField
- Defined in src/resources/resource.ts:92

get

get(): Promise<Editorial>
Get the resource from the API.

Returns Promise<Editorial>
Inherited from Resource.get
- Defined in src/resources/resource.ts:137