Class PlaylistDetailsRequest

Hierarchy (View Summary)

SearchRequest<Video.Details>
- PlaylistDetailsRequest

Index

Properties

current done options playlist total

Accessors

playlistName searchFilter

Methods

[asyncIterator] exec getPlaylistInfo nextPage

Properties

current

current: number

done

done: boolean

options

options: Required<Rev.SearchOptions<Video.Details>>

playlist

playlist: Playlist & Omit<DetailsResponse, "scrollId"> = ...

total

total: undefined | number

Accessors

playlistName

get playlistName(): string
Returns string
- Defined in src/api/playlist-details-request.ts:20

searchFilter

get searchFilter(): undefined | Video.SearchOptions
Returns undefined | Video.SearchOptions
- Defined in src/api/playlist-details-request.ts:23

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncGenerator<Video.Details, void>
Supports iterating through results using for await...

Returns AsyncGenerator<Video.Details, void>
See
MDN Docs
Inherited from SearchRequest.[asyncIterator]
- Defined in src/utils/paged-request.ts:174

exec

exec(): Promise<Video.Details[]>
Go through all pages of results and return as an array. TIP: Use the {maxResults} option to limit the maximum number of results

Returns Promise<Video.Details[]>
Inherited from SearchRequest.exec
- Defined in src/utils/paged-request.ts:162

getPlaylistInfo

getPlaylistInfo(): Promise<
    {
        id: string;
        name: string;
        playbackUrl: string;
        playlistDetails: Omit<Playlist, "videos"> & { videos?: undefined };
        playlistId: string;
        playlistName: string;
        playlistType: string & Record<never, never> | "Static" | "Dynamic";
        searchFilter: undefined | Video.SearchOptions;
        totalVideos?: string;
        videos: Video.Details[];
    },
>
Returns Promise<
    {
        id: string;
        name: string;
        playbackUrl: string;
        playlistDetails: Omit<Playlist, "videos"> & { videos?: undefined };
        playlistId: string;
        playlistName: string;
        playlistType: string & Record<never, never> | "Static" | "Dynamic";
        searchFilter: undefined | Video.SearchOptions;
        totalVideos?: string;
        videos: Video.Details[];
    },
>
- Defined in src/api/playlist-details-request.ts:51

nextPage

nextPage(): Promise<SearchPage<Video.Details>>
Get the next page of results from API

Returns Promise<SearchPage<Video.Details>>
Inherited from SearchRequest.nextPage
- Defined in src/utils/paged-request.ts:53