youtubei.js / YTMusic / Search

Class: Search

Constructors

new Search()

new Search(response, actions, is_filtered?): Search

Parameters

• response: ApiResponse

• actions: Actions

• is_filtered?: boolean

Returns

Search

Defined in

src/parser/ytmusic/Search.ts:29

Properties

contents?

optional contents: ObservedArray<ItemSection | MusicShelf | MusicCardShelf>

Defined in

src/parser/ytmusic/Search.ts:27

---

header?

optional header: ChipCloud

Defined in

src/parser/ytmusic/Search.ts:26

Accessors

albums

get albums(): undefined | MusicShelf

Returns

undefined | MusicShelf

Defined in

src/parser/ytmusic/Search.ts:138

---

artists

get artists(): undefined | MusicShelf

Returns

undefined | MusicShelf

Defined in

src/parser/ytmusic/Search.ts:142

---

did_you_mean

get did_you_mean(): undefined | DidYouMean

Returns

undefined | DidYouMean

Defined in

src/parser/ytmusic/Search.ts:118

---

filters

get filters(): string[]

Returns

string[]

Defined in

src/parser/ytmusic/Search.ts:110

---

has_continuation

get has_continuation(): boolean

Returns

boolean

Defined in

src/parser/ytmusic/Search.ts:114

---

message

get message(): undefined | Message

Returns

undefined | Message

Defined in

src/parser/ytmusic/Search.ts:126

---

page

get page(): ISearchResponse

Returns

ISearchResponse

Defined in

src/parser/ytmusic/Search.ts:164

---

playlists

get playlists(): undefined | MusicShelf

Returns

undefined | MusicShelf

Defined in

src/parser/ytmusic/Search.ts:146

---

results

get results(): undefined | ObservedArray<MusicResponsiveListItem>

Deprecated

Use Search.contents instead.

Returns

undefined | ObservedArray<MusicResponsiveListItem>

Defined in

src/parser/ytmusic/Search.ts:153

---

sections

get sections(): undefined | ObservedArray<MusicShelf>

Deprecated

Use Search.contents instead.

Returns

undefined | ObservedArray<MusicShelf>

Defined in

src/parser/ytmusic/Search.ts:160

---

showing_results_for

get showing_results_for(): undefined | ShowingResultsFor

Returns

undefined | ShowingResultsFor

Defined in

src/parser/ytmusic/Search.ts:122

---

songs

get songs(): undefined | MusicShelf

Returns

undefined | MusicShelf

Defined in

src/parser/ytmusic/Search.ts:130

---

videos

get videos(): undefined | MusicShelf

Returns

undefined | MusicShelf

Defined in

src/parser/ytmusic/Search.ts:134

Methods

applyFilter()

applyFilter(target_filter): Promise<Search>

Applies given filter to the search.

Parameters

• target_filter: string | ChipCloudChip

Returns

Promise<Search>

Defined in

src/parser/ytmusic/Search.ts:87

---

getContinuation()

getContinuation(): Promise<SearchContinuation>

Retrieves search continuation. Only available for filtered searches and shelf continuations.

Returns

Promise<SearchContinuation>

Defined in

src/parser/ytmusic/Search.ts:72

---

getMore()

getMore(shelf): Promise<Search>

Loads more items for the given shelf.

Parameters

• shelf: undefined | MusicShelf

Returns

Promise<Search>

Defined in

src/parser/ytmusic/Search.ts:57