youtubei.js / YT / Search

Class: Search

Defined in: src/parser/youtube/Search.ts:18

Extends

Feed<ISearchResponse>

Constructors

Constructor

new Search(actions, data, already_parsed?): Search

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

Parameters

actions

data

ApiResponse | ISearchResponse

already_parsed?

boolean = false

Returns

Search

Overrides

Feed.constructor

Properties

estimated_results

estimated_results: number

Defined in: src/parser/youtube/Search.ts:22

optional header: SearchHeader

Defined in: src/parser/youtube/Search.ts:19

refinements: string[]

Defined in: src/parser/youtube/Search.ts:21

results

results: ObservedArray<YTNode>

Defined in: src/parser/youtube/Search.ts:20

optional sub_menu: SearchSubMenu

Defined in: src/parser/youtube/Search.ts:23

watch_card?

optional watch_card: UniversalWatchCard

Defined in: src/parser/youtube/Search.ts:24

Accessors

actions

Get Signature

get actions(): Actions

Defined in: src/core/mixins/Feed.ts:181

Returns

Inherited from

Feed.actions

channels

Get Signature

get channels(): ObservedArray<Channel | GridChannel>

Defined in: src/core/mixins/Feed.ts:127

Get all the channels in the feed

Returns

ObservedArray<Channel | GridChannel>

Inherited from

Feed.channels

has_continuation

Get Signature

get has_continuation(): boolean

Defined in: src/core/mixins/Feed.ts:195

Checks if the feed has continuation.

Returns

boolean

Inherited from

Feed.has_continuation

memo

Get Signature

get memo(): Memo

Defined in: src/core/mixins/Feed.ts:138

Returns

Inherited from

page

Get Signature

get page(): T

Defined in: src/core/mixins/Feed.ts:188

Get the original page data

Returns

T

Inherited from

page_contents

Get Signature

get page_contents(): SectionList | MusicQueue | RichGrid | ReloadContinuationItemsCommand

Defined in: src/core/mixins/Feed.ts:145

Returns contents from the page.

Returns

SectionList | MusicQueue | RichGrid | ReloadContinuationItemsCommand

Inherited from

Feed.page_contents

playlists

Get Signature

get playlists(): ObservedArray<GridPlaylist | LockupView | Playlist>

Defined in: src/core/mixins/Feed.ts:134

Get all playlists in the feed

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

Feed.playlists

posts

Get Signature

get posts(): ObservedArray<BackstagePost | Post | SharedPost>

Defined in: src/core/mixins/Feed.ts:120

Get all the community posts in the feed

Returns

ObservedArray<BackstagePost | Post | SharedPost>

Inherited from

Get Signature

get refinement_filters(): string[]

Defined in: src/parser/youtube/Search.ts:100

Returns a list of available refinement filters. Use Search.applyRefinement to apply a filter.

Returns

string[]

secondary_contents

Get Signature

get secondary_contents(): SectionList | BrowseFeedActions | ProfileColumn | SecondarySearchContainer | null

Defined in: src/core/mixins/Feed.ts:169

Returns secondary contents from the page.

Returns

SectionList | BrowseFeedActions | ProfileColumn | SecondarySearchContainer | null

Inherited from

Feed.secondary_contents

shelves

Get Signature

get shelves(): ObservedArray<ReelShelf | RichShelf | Shelf>

Defined in: src/core/mixins/Feed.ts:155

Returns all segments/sections from the page.

Returns

ObservedArray<ReelShelf | RichShelf | Shelf>

Inherited from

Feed.shelves

videos

Get Signature

get videos(): ObservedArray<CompactVideo | GridVideo | LockupView | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Defined in: src/core/mixins/Feed.ts:113

Get all the videos in the feed

Returns

ObservedArray<CompactVideo | GridVideo | LockupView | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Inherited from

Feed.videos

Methods

applyRefinement()

applyRefinement(refinementFilter): Promise<Search>

Defined in: src/parser/youtube/Search.ts:69

Applies a refinement filter to the search results.

Use Search.refinement_filters to get a list of available refinements.

Parameters

refinementFilter

The text label of the chip or the ChipCloudChip node itself.

string | ChipCloudChip

Returns

Promise<Search>

Example

const results = await yt.search('PilotRedSun');
// Narrow down to only YouTube Shorts
const shortsOnly = await results.applyRefinement('Shorts');

getContinuation()

getContinuation(): Promise<Search>

Defined in: src/parser/youtube/Search.ts:107

Retrieves next batch of search results.

Returns

Promise<Search>

Overrides

Feed.getContinuation

getContinuationData()

getContinuationData(): Promise<ISearchResponse | undefined>

Defined in: src/core/mixins/Feed.ts:202

Retrieves continuation data as it is.

Returns

Promise<ISearchResponse | undefined>

Inherited from

Feed.getContinuationData

getShelf()

getShelf(title): ReelShelf | RichShelf | Shelf | undefined

Defined in: src/core/mixins/Feed.ts:162

Finds shelf by title.

Parameters

title

string

Returns

ReelShelf | RichShelf | Shelf | undefined

Inherited from

Feed.getShelf

getPlaylistsFromMemo()

static getPlaylistsFromMemo(memo): ObservedArray<GridPlaylist | LockupView | Playlist>

Defined in: src/core/mixins/Feed.ts:95

Get all playlists on a given page via memo

Parameters

memo

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

Feed.getPlaylistsFromMemo

getVideosFromMemo()

static getVideosFromMemo(memo): ObservedArray<CompactVideo | GridVideo | LockupView | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Defined in: src/core/mixins/Feed.ts:78

Get all videos on a given page via memo

Parameters

memo

Returns

ObservedArray<CompactVideo | GridVideo | LockupView | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

Inherited from

Feed.getVideosFromMemo