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

Defined in: src/parser/ytmusic/Search.ts:28

Parameters

response

ApiResponse

actions

Actions

is_filtered?

boolean

Returns

Search

Properties

contents?

optional contents: ObservedArray<ItemSection | MusicShelf | MusicCardShelf>

Defined in: src/parser/ytmusic/Search.ts:26

optional header: ChipCloud

Defined in: src/parser/ytmusic/Search.ts:25

Accessors

albums

Get Signature

get albums(): MusicShelf | undefined

Defined in: src/parser/ytmusic/Search.ts:137

Returns

MusicShelf | undefined

artists

Get Signature

get artists(): MusicShelf | undefined

Defined in: src/parser/ytmusic/Search.ts:141

Returns

MusicShelf | undefined

did_you_mean

Get Signature

get did_you_mean(): DidYouMean | undefined

Defined in: src/parser/ytmusic/Search.ts:117

Returns

DidYouMean | undefined

filters

Get Signature

get filters(): string[]

Defined in: src/parser/ytmusic/Search.ts:109

Returns

string[]

has_continuation

Get Signature

get has_continuation(): boolean

Defined in: src/parser/ytmusic/Search.ts:113

Returns

boolean

message

Get Signature

get message(): Message | undefined

Defined in: src/parser/ytmusic/Search.ts:125

Returns

Message | undefined

playlists

Get Signature

get playlists(): MusicShelf | undefined

Defined in: src/parser/ytmusic/Search.ts:145

Returns

MusicShelf | undefined

showing_results_for

Get Signature

get showing_results_for(): ShowingResultsFor | undefined

Defined in: src/parser/ytmusic/Search.ts:121

Returns

ShowingResultsFor | undefined

songs

Get Signature

get songs(): MusicShelf | undefined

Defined in: src/parser/ytmusic/Search.ts:129

Returns

MusicShelf | undefined

videos

Get Signature

get videos(): MusicShelf | undefined

Defined in: src/parser/ytmusic/Search.ts:133

Returns

MusicShelf | undefined

Methods

applyFilter()

applyFilter(target_filter): Promise<Search>

Defined in: src/parser/ytmusic/Search.ts:86

Applies given filter to the search.

Parameters

target_filter

string | ChipCloudChip

Returns

Promise<Search>

getContinuation()

getContinuation(): Promise<SearchContinuation>

Defined in: src/parser/ytmusic/Search.ts:71

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

Returns

Promise<SearchContinuation>

getMore()

getMore(shelf): Promise<Search>

Defined in: src/parser/ytmusic/Search.ts:56

Loads more items for the given shelf.

Parameters

shelf

MusicShelf | undefined

Returns

Promise<Search>