Class MetatagTree

A metatag navigation tree (for example "moods", "genres").

Hierarchy (View Summary)

YandexMusicModel
- MetatagTree

Index

Constructors

Properties

client? leaves? navigationId? title?

Methods

deJson requireClient

Constructors

constructor

new MetatagTree(client?: Client): MetatagTree
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns MetatagTree
Inherited from YandexMusicModel.constructor
- Defined in src/base.ts:177

Properties

`Optional`client

client?: Client

The client that created this model, used by convenience methods.

`Optional`leaves

leaves?: MetatagLeaf[]

Top-level leaves.

`Optional`navigationId

navigationId?: string

Navigation id (known values: moods, activities, genres, epochs).

`Optional`title

title?: string

Tree title.

Methods

`Static`deJson

deJson(raw: JSONValue | undefined, client?: Client): MetatagTree | null
Parameters
- raw: JSONValue | undefined
- Optionalclient: Client
Returns MetatagTree | null
See
MetatagTree
- Defined in src/models/metatag/metatag.ts:93

`Protected`requireClient

requireClient(): Client
Assert that this model carries a client, returning it narrowed to non-null.

Convenience methods that need to call the API use this to fail fast with a clear message instead of a generic "cannot read property of undefined".

Returns Client
The owning Client.

Throws
When the model was created without a client.
Inherited from YandexMusicModel.requireClient
- Defined in src/base.ts:190