Class User

A Yandex Music user (for example a playlist owner).

Hierarchy (View Summary)

YandexMusicModel
- User

Index

Constructors

Properties

client? displayName? fullName? login? name? regions? sex? uid? verified?

Methods

deJson requireClient

Constructors

constructor

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

displayName?: string

Display name.

`Optional`fullName

fullName?: string

Full name.

`Optional`login

login?: string

Login.

`Optional`name

name?: string

Account name.

`Optional`regions

regions?: number[]

Region codes.

`Optional`sex

sex?: string

Reported sex.

`Optional`uid

uid?: number

User uid.

`Optional`verified

verified?: boolean

Whether the user is verified.

Methods

`Static`deJson

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

`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