Class Suggestions

Search suggestions for a partial query.

Hierarchy (View Summary)

YandexMusicModel
- Suggestions

Index

Constructors

Properties

best? client? suggestions?

Methods

deJson requireClient

Constructors

constructor

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

Properties

`Optional`best

best?: Best

The best matching entity for the partial query.

`Optional`client

client?: Client

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

`Optional`suggestions

suggestions?: string[]

Suggested completion strings.

Methods

`Static`deJson

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

`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