Class SearchResult<T>

One typed block of search results (for example all matching tracks).

Type Parameters

T extends SearchEntity = SearchEntity
The entity type contained in SearchResult.results.

Hierarchy (View Summary)

YandexMusicModel
- SearchResult

Index

Constructors

Properties

client? order? perPage? results? total? type?

Methods

deJson requireClient

Constructors

constructor

new SearchResult<T extends SearchEntity = SearchEntity>(
client?: Client,
): SearchResult<T>
Type Parameters
- T extends SearchEntity = SearchEntity
  The entity type contained in SearchResult.results.
Parameters
- Optionalclient: Client
  The owning client, stored for later convenience calls.
Returns SearchResult<T>
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`order

order?: number

Display order of this block.

`Optional`perPage

perPage?: number

Maximum results per page.

`Optional`results

results?: T[]

The matched entities.

`Optional`total

total?: number

Total number of matches.

`Optional`type

type?: string

Result type (track, artist, album, playlist, video, user).

Methods

`Static`deJson

deJson<T extends SearchEntity>(
    raw: JSONValue | undefined,
    client: Client | undefined,
    deJson: DeJson<T>,
    type?: string,
): SearchResult<T> | null
Deserialize a SearchResult using a specific entity deserializer.
Type Parameters
- T extends SearchEntity
  The entity type produced.
Parameters
- raw: JSONValue | undefined
  Raw JSON value from the API.
- client: Client | undefined
  The owning client.
- deJson: DeJson<T>
  Deserializer for the entity stored in results.
- Optionaltype: string
  Result type to record when the payload omits it.
Returns SearchResult<T> | null
The model, or null when raw is not an object.
- Defined in src/models/search/search.ts:60

`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