Discord Player
Generated APITypeScript@discord-player/plugin-host

SearchResult

Familiar search result wrapper used by Player-level playback.

You are reading the v8 docsDev
ClassTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/structures/search-result.ts:14
class SearchResult

Familiar search result wrapper used by Player-level playback.

Constructors

constructor

constructor(data: SearchResultData)

Create a result from resolved tracks and optional playlist metadata.

Parameters

NameTypeDescription
dataSearchResultData

Search result payload.

Properties

tracksreadonly

readonly tracks: Track<unknown>[]

Tracks returned by the search operation.

playlistreadonly

readonly playlist: Playlist | null

Playlist metadata returned with the tracks, when available.

Methods

isEmpty

isEmpty(): boolean

Whether this result contains no Tracks.

Returns

boolean

first

first(): Track<unknown> | null

Retrieve the first Track in the search result. Null if no tracks are available.

Returns

Track<unknown> | null

first(count: number): Track<unknown>[]

Retrieve the first N Tracks in the search result.

Parameters

NameTypeDescription
countnumber

Returns

Track<unknown>[]

Static methods

emptystatic

static empty(): SearchResult

Create an empty result when no source integration can resolve a query.

Returns

SearchResult

SafeEventEmitter

Typed EventEmitter with a fallback error listener so unobserved errors do not crash the process.

SerializationError

Error thrown when a serialization input cannot be encoded or decoded.

On this page

ConstructorsconstructorPropertiestracksplaylistMethodsisEmptyfirstStatic methodsempty