Class Radio

To work with Deezer radio objects.

See

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

Hierarchy (View Summary)

Resource
- Radio

Index

Constructors

Properties

title description share picture picture_small picture_medium picture_big picture_xl tracklist md5_image client _fields _fetched id type

Methods

getTracks toJSON getRelation getPaginatedList ensureField get

Constructors

constructor

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

Properties

title

title: string

description

description: string

share

share: string

picture

picture: string

picture_small

picture_small: string

picture_medium

picture_medium: string

picture_big

picture_big: string

picture_xl

picture_xl: string

tracklist

tracklist: string

md5_image

md5_image: string

`Protected` `Readonly`client

client: Client

`Protected`_fields

_fields: string[]

`Protected`_fetched

_fetched: boolean = false

id

id: number

type

type: string

Methods

getTracks

getTracks(): Promise<Track[]>
Get first 40 tracks in the radio.

Note that this endpoint is NOT paginated.

Returns Promise<Track[]>
- list of Track instances.
- Defined in src/resources/radio.ts:33

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<Radio>
Get the resource from the API.

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