Class TrackPosition

Position of a track within an album (disc and index).

Hierarchy (View Summary)

YandexMusicModel
- TrackPosition

Index

Constructors

Properties

client? index? volume?

Methods

deJson requireClient

Constructors

constructor

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

index?: number

Track index within the volume, 1-based.

`Optional`volume

volume?: number

Volume (disc) number, 1-based.

Methods

`Static`deJson

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

`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