Class MetatagLeaf

A leaf in a metatag navigation tree (may nest further leaves).

Hierarchy (View Summary)

YandexMusicModel
- MetatagLeaf

Index

Constructors

Properties

client? leaves? tag? title?

Methods

deJson requireClient

Constructors

constructor

new MetatagLeaf(client?: Client): MetatagLeaf
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns MetatagLeaf
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[]

Nested leaves.

`Optional`tag

tag?: string

Tag id used as the metatag identifier in requests.

`Optional`title

title?: string

Leaf title.

Methods

`Static`deJson

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

`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