Class Resource

Base class for all Deezer resources. All resource classes inherit from this class.

Hierarchy (View Summary)

Resource

Index

Constructors

Properties

client _fields _fetched id type

Methods

toJSON getRelation getPaginatedList ensureField get

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: Client

`Protected`_fields

_fields: string[]

`Protected`_fetched

_fetched: boolean = false

id

id: number

type

type: string

Methods

toJSON

toJSON(): Record<string, any>
Returns Record<string, any>
- 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>
- 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>
- 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
- Defined in src/resources/resource.ts:92

get

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

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