youtubei.js / YT / Playlist

Class: Playlist

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

Extends

• Feed<IBrowseResponse>

Constructors

Constructor

new Playlist(actions, data, already_parsed): Playlist

Defined in: src/parser/youtube/Playlist.ts:32

Parameters

actions

Actions

data

ApiResponse | IBrowseResponse

already_parsed

boolean = false

Returns

Playlist

Overrides

Feed.constructor

Properties

endpoint?

optional endpoint: NavigationEndpoint

Defined in: src/parser/youtube/Playlist.ts:29

info

info: object

Defined in: src/parser/youtube/Playlist.ts:27

author

author: Author

can_delete

can_delete: boolean = header.can_delete

can_reorder

can_reorder: boolean = video_list.can_reorder

can_share

can_share: boolean = header.can_share

description?

optional description: string

is_editable

is_editable: boolean = video_list.is_editable

last_updated

last_updated: string

privacy

privacy: string = header.privacy

subtitle

subtitle: Text | null

thumbnails

thumbnails: Thumbnail[]

title?

optional title: string

total_items

total_items: string

type?

readonly optional type: string

views

views: string

menu

menu: YTNode

Defined in: src/parser/youtube/Playlist.ts:28

messages

messages: ObservedArray<Message>

Defined in: src/parser/youtube/Playlist.ts:30

Accessors

actions

Get Signature

get actions(): Actions

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

Returns

Actions

Inherited from

Feed.actions

channels

Get Signature

get channels(): ObservedArray<Channel | GridChannel>

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

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/parser/youtube/Playlist.ts:73

Checks if the feed has continuation.

Returns

boolean

Overrides

Feed.has_continuation

items

Get Signature

get items(): ObservedArray<PlaylistVideo | ReelItem | ShortsLockupView>

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

Returns

ObservedArray<PlaylistVideo | ReelItem | ShortsLockupView>

memo

Get Signature

get memo(): Memo

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

Returns

Memo

Inherited from

Feed.memo

page

Get Signature

get page(): T

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

Get the original page data

Returns

T

Inherited from

Feed.page

page_contents

Get Signature

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

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

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:133

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:119

Get all the community posts in the feed

Returns

ObservedArray<BackstagePost | Post | SharedPost>

Inherited from

Feed.posts

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 | PlaylistPanelVideo | PlaylistVideo | ReelItem | ShortsLockupView | Video | WatchCardCompactVideo>

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

Get all the videos in the feed

Returns

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

Inherited from

Feed.videos

Methods

getContinuation()

getContinuation(): Promise<Playlist>

Defined in: src/parser/youtube/Playlist.ts:101

Retrieves next batch of contents and returns a new Feed object.

Returns

Promise<Playlist>

Overrides

Feed.getContinuation

getContinuationData()

getContinuationData(): Promise<IBrowseResponse | undefined>

Defined in: src/parser/youtube/Playlist.ts:82

Retrieves continuation data as it is.

Returns

Promise<IBrowseResponse | undefined>

Overrides

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:94

Get all playlists on a given page via memo

Parameters

memo

Memo

Returns

ObservedArray<GridPlaylist | LockupView | Playlist>

Inherited from

Feed.getPlaylistsFromMemo

getVideosFromMemo()

static getVideosFromMemo(memo): ObservedArray<CompactVideo | GridVideo | 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

Memo

Returns

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

Inherited from

Feed.getVideosFromMemo