Class YouTubePlayList

Class for YouTube Playlist url

Hierarchy

YouTubePlayList

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new YouTubePlayList(data: any, searchResult?: boolean): YouTubePlayList

- Defined in play-dl/YouTube/classes/Playlist.ts:34
Parameters
- data: any
- searchResult: boolean = false
Returns YouTubePlayList

Properties

Private __count

__count: number

Private _continuation

_continuation: { api?: string; clientVersion?: string; token?: string } = {}

Type declaration

Optional api?: string
Optional clientVersion?: string
Optional token?: string

Optional channel

channel?: YouTubeChannel

Private fetched_videos

fetched_videos: <internal>.Map<string, YouTubeVideo[]>

Optional id

id?: string

Optional lastUpdate

lastUpdate?: string

Optional link

link?: string

Optional thumbnail

thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }

Type declaration

height: undefined | number
id: undefined | string
url: undefined | string
width: undefined | number

Optional title

title?: string

type

type: "video" | "playlist" | "channel"

Optional url

url?: string

Optional videoCount

videoCount?: number

Private Optional videos

videos?: []

Optional views

views?: number

Accessors

total_pages

get total_pages(): number

- Defined in play-dl/YouTube/classes/Playlist.ts:126
Returns number

total_videos

get total_videos(): number

- Defined in play-dl/YouTube/classes/Playlist.ts:130
Returns number

Methods

Private __patch

__patch(data: any): void

- Defined in play-dl/YouTube/classes/Playlist.ts:43
Parameters
- data: any
Returns void

Private __patchSearch

__patchSearch(data: any): void

- Defined in play-dl/YouTube/classes/Playlist.ts:61
Parameters
- data: any
Returns void

fetch

fetch(max?: number): <internal>.Promise<YouTubePlayList>

- Defined in play-dl/YouTube/classes/Playlist.ts:105
Parameters
- max: number = Infinity
Returns <internal>.Promise<YouTubePlayList>

next

next(limit?: number): <internal>.Promise<YouTubeVideo[]>

- Defined in play-dl/YouTube/classes/Playlist.ts:74
Parameters
- limit: number = Infinity
Returns <internal>.Promise<YouTubeVideo[]>

page

page(number: number): YouTubeVideo[]

- Defined in play-dl/YouTube/classes/Playlist.ts:120
Parameters
- number: number
Returns YouTubeVideo[]

toJSON

toJSON(): { channel: { icon: undefined | string; id: undefined | string; name: undefined | string }; id: undefined | string; thumbnail: undefined | { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }; title: undefined | string; url: undefined | string; videos: undefined | [] }

- Defined in play-dl/YouTube/classes/Playlist.ts:135
Returns { channel: { icon: undefined | string; id: undefined | string; name: undefined | string }; id: undefined | string; thumbnail: undefined | { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }; title: undefined | string; url: undefined | string; videos: undefined | [] }
- channel: { icon: undefined | string; id: undefined | string; name: undefined | string }
  - icon: undefined | string
  - id: undefined | string
  - name: undefined | string
- id: undefined | string
- thumbnail: undefined | { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }
- title: undefined | string
- url: undefined | string
- videos: undefined | []

Generated using TypeDoc