jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-07-04 12:47:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Regen API ref

Browse Source
This commit is contained in:
LuanRT
2026-05-12 23:01:15 -03:00
parent 853a36307b
commit 0a82c8bd99
857 changed files with 8999 additions and 8813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
docs/api/youtubei.js/namespaces/YT/classes/Search.md
View File

@@ -2,7 +2,7 @@
# Class: Search
Defined in: [src/parser/youtube/Search.ts:19](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L19)
Defined in: [src/parser/youtube/Search.ts:18](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L18)
## Extends
@@ -14,7 +14,7 @@ Defined in: [src/parser/youtube/Search.ts:19](https://github.com/LuanRT/YouTube.
> **new Search**(`actions`, `data`, `already_parsed?`): `Search`
Defined in: [src/parser/youtube/Search.ts:28](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L28)
Defined in: [src/parser/youtube/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L26)
#### Parameters
@@ -44,7 +44,7 @@ Defined in: [src/parser/youtube/Search.ts:28](https://github.com/LuanRT/YouTube.
> **estimated\_results**: `number`
Defined in: [src/parser/youtube/Search.ts:23](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L23)
Defined in: [src/parser/youtube/Search.ts:22](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L22)
***
@@ -52,15 +52,7 @@ Defined in: [src/parser/youtube/Search.ts:23](https://github.com/LuanRT/YouTube.
> `optional` **header**: [`SearchHeader`](../../YTNodes/classes/SearchHeader.md)
Defined in: [src/parser/youtube/Search.ts:20](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L20)
***
### refinement\_cards?
> `optional` **refinement\_cards**: [`HorizontalCardList`](../../YTNodes/classes/HorizontalCardList.md) \| `null`
Defined in: [src/parser/youtube/Search.ts:26](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L26)
Defined in: [src/parser/youtube/Search.ts:19](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L19)
***
@@ -68,7 +60,7 @@ Defined in: [src/parser/youtube/Search.ts:26](https://github.com/LuanRT/YouTube.
> **refinements**: `string`[]
Defined in: [src/parser/youtube/Search.ts:22](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L22)
Defined in: [src/parser/youtube/Search.ts:21](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L21)
***
@@ -76,7 +68,7 @@ Defined in: [src/parser/youtube/Search.ts:22](https://github.com/LuanRT/YouTube.
> **results**: [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`YTNode`](../../Helpers/classes/YTNode.md)\>
Defined in: [src/parser/youtube/Search.ts:21](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L21)
Defined in: [src/parser/youtube/Search.ts:20](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L20)
***
@@ -84,7 +76,7 @@ Defined in: [src/parser/youtube/Search.ts:21](https://github.com/LuanRT/YouTube.
> `optional` **sub\_menu**: [`SearchSubMenu`](../../YTNodes/classes/SearchSubMenu.md)
Defined in: [src/parser/youtube/Search.ts:24](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L24)
Defined in: [src/parser/youtube/Search.ts:23](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L23)
***
@@ -92,7 +84,7 @@ Defined in: [src/parser/youtube/Search.ts:24](https://github.com/LuanRT/YouTube.
> `optional` **watch\_card**: [`UniversalWatchCard`](../../YTNodes/classes/UniversalWatchCard.md)
Defined in: [src/parser/youtube/Search.ts:25](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L25)
Defined in: [src/parser/youtube/Search.ts:24](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L24)
## Accessors
@@ -102,7 +94,7 @@ Defined in: [src/parser/youtube/Search.ts:25](https://github.com/LuanRT/YouTube.
> **get** **actions**(): [`Actions`](../../../../classes/Actions.md)
Defined in: [src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L181)
Defined in: [src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L181)
##### Returns
@@ -120,7 +112,7 @@ Defined in: [src/core/mixins/Feed.ts:181](https://github.com/LuanRT/YouTube.js/b
> **get** **channels**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`Channel`](../../YTNodes/classes/Channel.md) \| [`GridChannel`](../../YTNodes/classes/GridChannel.md)\>
Defined in: [src/core/mixins/Feed.ts:127](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L127)
Defined in: [src/core/mixins/Feed.ts:127](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L127)
Get all the channels in the feed
@@ -140,7 +132,7 @@ Get all the channels in the feed
> **get** **has\_continuation**(): `boolean`
Defined in: [src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L195)
Defined in: [src/core/mixins/Feed.ts:195](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L195)
Checks if the feed has continuation.
@@ -160,7 +152,7 @@ Checks if the feed has continuation.
> **get** **memo**(): [`Memo`](../../Helpers/classes/Memo.md)
Defined in: [src/core/mixins/Feed.ts:138](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L138)
Defined in: [src/core/mixins/Feed.ts:138](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L138)
##### Returns
@@ -178,7 +170,7 @@ Defined in: [src/core/mixins/Feed.ts:138](https://github.com/LuanRT/YouTube.js/b
> **get** **page**(): `T`
Defined in: [src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L188)
Defined in: [src/core/mixins/Feed.ts:188](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L188)
Get the original page data
@@ -198,7 +190,7 @@ Get the original page data
> **get** **page\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`MusicQueue`](../../YTNodes/classes/MusicQueue.md) \| [`RichGrid`](../../YTNodes/classes/RichGrid.md) \| [`ReloadContinuationItemsCommand`](../../../../classes/ReloadContinuationItemsCommand.md)
Defined in: [src/core/mixins/Feed.ts:145](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L145)
Defined in: [src/core/mixins/Feed.ts:145](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L145)
Returns contents from the page.
@@ -218,7 +210,7 @@ Returns contents from the page.
> **get** **playlists**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\>
Defined in: [src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L134)
Defined in: [src/core/mixins/Feed.ts:134](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L134)
Get all playlists in the feed
@@ -238,7 +230,7 @@ Get all playlists in the feed
> **get** **posts**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`BackstagePost`](../../YTNodes/classes/BackstagePost.md) \| [`Post`](../../YTNodes/classes/Post.md) \| [`SharedPost`](../../YTNodes/classes/SharedPost.md)\>
Defined in: [src/core/mixins/Feed.ts:120](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L120)
Defined in: [src/core/mixins/Feed.ts:120](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L120)
Get all the community posts in the feed
@@ -252,15 +244,15 @@ Get all the community posts in the feed
***
### refinement\_card\_queries
### refinement\_filters
#### Get Signature
> **get** **refinement\_card\_queries**(): `string`[]
> **get** **refinement\_filters**(): `string`[]
Defined in: [src/parser/youtube/Search.ts:81](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L81)
Defined in: [src/parser/youtube/Search.ts:100](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L100)
Returns a list of refinement card queries.
Returns a list of available refinement filters. Use [Search.applyRefinement](#applyrefinement) to apply a filter.
##### Returns
@@ -274,7 +266,7 @@ Returns a list of refinement card queries.
> **get** **secondary\_contents**(): [`SectionList`](../../YTNodes/classes/SectionList.md) \| [`BrowseFeedActions`](../../YTNodes/classes/BrowseFeedActions.md) \| [`ProfileColumn`](../../YTNodes/classes/ProfileColumn.md) \| [`SecondarySearchContainer`](../../YTNodes/classes/SecondarySearchContainer.md) \| `null`
Defined in: [src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L169)
Defined in: [src/core/mixins/Feed.ts:169](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L169)
Returns secondary contents from the page.
@@ -294,7 +286,7 @@ Returns secondary contents from the page.
> **get** **shelves**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md)\>
Defined in: [src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L155)
Defined in: [src/core/mixins/Feed.ts:155](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L155)
Returns all segments/sections from the page.
@@ -314,7 +306,7 @@ Returns all segments/sections from the page.
> **get** **videos**(): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\>
Defined in: [src/core/mixins/Feed.ts:113](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L113)
Defined in: [src/core/mixins/Feed.ts:113](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L113)
Get all the videos in the feed
@@ -328,11 +320,43 @@ Get all the videos in the feed
## Methods
### applyRefinement()
> **applyRefinement**(`refinementFilter`): `Promise`\<`Search`\>
Defined in: [src/parser/youtube/Search.ts:69](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L69)
Applies a refinement filter to the search results.
Use [Search.refinement\_filters](#refinement_filters) to get a list of available refinements.
#### Parameters
##### refinementFilter
The text label of the chip or the [ChipCloudChip](../../YTNodes/classes/ChipCloudChip.md) node itself.
`string` | [`ChipCloudChip`](../../YTNodes/classes/ChipCloudChip.md)
#### Returns
`Promise`\<`Search`\>
#### Example
```ts
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:88](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L88)
Defined in: [src/parser/youtube/Search.ts:107](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/parser/youtube/Search.ts#L107)
Retrieves next batch of search results.
@@ -350,7 +374,7 @@ Retrieves next batch of search results.
> **getContinuationData**(): `Promise`\<[`ISearchResponse`](../../../../type-aliases/ISearchResponse.md) \| `undefined`\>
Defined in: [src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L202)
Defined in: [src/core/mixins/Feed.ts:202](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L202)
Retrieves continuation data as it is.
@@ -368,7 +392,7 @@ Retrieves continuation data as it is.
> **getShelf**(`title`): [`ReelShelf`](../../YTNodes/classes/ReelShelf.md) \| [`RichShelf`](../../YTNodes/classes/RichShelf.md) \| [`Shelf`](../../YTNodes/classes/Shelf.md) \| `undefined`
Defined in: [src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L162)
Defined in: [src/core/mixins/Feed.ts:162](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L162)
Finds shelf by title.
@@ -388,31 +412,11 @@ Finds shelf by title.
***
### selectRefinementCard()
> **selectRefinementCard**(`card`): `Promise`\<`Search`\>
Defined in: [src/parser/youtube/Search.ts:57](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/parser/youtube/Search.ts#L57)
Applies given refinement card and returns a new Search object. Use [refinement\_card\_queries](#refinement_card_queries) to get a list of available refinement cards.
#### Parameters
##### card
`string` | [`SearchRefinementCard`](../../YTNodes/classes/SearchRefinementCard.md)
#### Returns
`Promise`\<`Search`\>
***
### getPlaylistsFromMemo()
> `static` **getPlaylistsFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`GridPlaylist`](../../YTNodes/classes/GridPlaylist.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`Playlist`](../../YTNodes/classes/Playlist.md)\>
Defined in: [src/core/mixins/Feed.ts:95](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L95)
Defined in: [src/core/mixins/Feed.ts:95](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L95)
Get all playlists on a given page via memo
@@ -436,7 +440,7 @@ Get all playlists on a given page via memo
> `static` **getVideosFromMemo**(`memo`): [`ObservedArray`](../../Helpers/type-aliases/ObservedArray.md)\<[`CompactVideo`](../../YTNodes/classes/CompactVideo.md) \| [`GridVideo`](../../YTNodes/classes/GridVideo.md) \| [`LockupView`](../../YTNodes/classes/LockupView.md) \| [`PlaylistPanelVideo`](../../YTNodes/classes/PlaylistPanelVideo.md) \| [`PlaylistVideo`](../../YTNodes/classes/PlaylistVideo.md) \| [`ReelItem`](../../YTNodes/classes/ReelItem.md) \| [`ShortsLockupView`](../../YTNodes/classes/ShortsLockupView.md) \| [`Video`](../../YTNodes/classes/Video.md) \| [`WatchCardCompactVideo`](../../YTNodes/classes/WatchCardCompactVideo.md)\>
Defined in: [src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/faaf5fc5c15ff93eac8442b2fbdb4767d9a47b3f/src/core/mixins/Feed.ts#L78)
Defined in: [src/core/mixins/Feed.ts:78](https://github.com/LuanRT/YouTube.js/blob/853a36307b5d644ada14dcb1216c2c22c2ae7b73/src/core/mixins/Feed.ts#L78)
Get all videos on a given page via memo