@np-dev/youtubei-js

import type { SessionOptions } from './core/Session.js'; import Session from './core/Session.js'; import NavigationEndpoint from './parser/classes/NavigationEndpoint.js'; import type Format from './parser/classes/misc/Format.js'; import Channel from './parser/youtube/Channel.js'; import Comments from './parser/youtube/Comments.js'; import Guide from './parser/youtube/Guide.js'; import HashtagFeed from './parser/youtube/HashtagFeed.js'; import History from './parser/youtube/History.js'; import HomeFeed from './parser/youtube/HomeFeed.js'; import Library from './parser/youtube/Library.js'; import NotificationsMenu from './parser/youtube/NotificationsMenu.js'; import Playlist from './parser/youtube/Playlist.js'; import Search from './parser/youtube/Search.js'; import VideoInfo from './parser/youtube/VideoInfo.js'; import ShortsVideoInfo from './parser/ytshorts/VideoInfo.js'; import { Kids, Music, Studio } from './core/clients/index.js'; import { AccountManager, InteractionManager, PlaylistManager } from './core/managers/index.js'; import { Feed, TabbedFeed } from './core/mixins/index.js'; import type { ApiResponse } from './core/Actions.js'; import { type IBrowseResponse, type IParsedResponse } from './parser/types/index.js'; import type { DownloadOptions, FormatOptions } from './types/FormatUtils.js'; export type InnertubeConfig = SessionOptions; export type InnerTubeClient = 'WEB' | 'iOS' | 'ANDROID' | 'YTMUSIC_ANDROID' | 'YTMUSIC' | 'YTSTUDIO_ANDROID' | 'TV_EMBEDDED' | 'YTKIDS'; export type SearchFilters = Partial<{ upload_date: 'all' | 'hour' | 'today' | 'week' | 'month' | 'year'; type: 'all' | 'video' | 'channel' | 'playlist' | 'movie'; duration: 'all' | 'short' | 'medium' | 'long'; sort_by: 'relevance' | 'rating' | 'upload_date' | 'view_count'; features: ('hd' | 'subtitles' | 'creative_commons' | '3d' | 'live' | 'purchased' | '4k' | '360' | 'location' | 'hdr' | 'vr180')[]; }>; /** * Provides access to various services and modules in the YouTube API. */ export default class Innertube { #private; constructor(session: Session); static create(config?: InnertubeConfig): Promise<Innertube>; /** * Retrieves video info. * @param target - The video id or `NavigationEndpoint`. * @param client - The client to use. */ getInfo(target: string | NavigationEndpoint, client?: InnerTubeClient): Promise<VideoInfo>; /** * Retrieves basic video info. * @param video_id - The video id. * @param client - The client to use. */ getBasicInfo(video_id: string, client?: InnerTubeClient): Promise<VideoInfo>; /** * Retrieves shorts info. * @param short_id - The short id. * @param client - The client to use. */ getShortsWatchItem(short_id: string, client?: InnerTubeClient): Promise<ShortsVideoInfo>; /** * Searches a given query. * @param query - The search query. * @param filters - Search filters. */ search(query: string, filters?: SearchFilters): Promise<Search>; /** * Retrieves search suggestions for a given query. * @param query - The search query. */ getSearchSuggestions(query: string): Promise<string[]>; /** * Retrieves comments for a video. * @param video_id - The video id. * @param sort_by - Sorting options. */ getComments(video_id: string, sort_by?: 'TOP_COMMENTS' | 'NEWEST_FIRST'): Promise<Comments>; /** * Retrieves YouTube's home feed (aka recommendations). */ getHomeFeed(): Promise<HomeFeed>; /** * Retrieves YouTube's content guide. */ getGuide(): Promise<Guide>; /** * Returns the account's library. */ getLibrary(): Promise<Library>; /** * Retrieves watch history. * Which can also be achieved with {@link getLibrary}. */ getHistory(): Promise<History>; /** * Retrieves trending content. */ getTrending(): Promise<TabbedFeed<IBrowseResponse>>; /** * Retrieves subscriptions feed. */ getSubscriptionsFeed(): Promise<Feed<IBrowseResponse>>; /** * Retrieves contents for a given channel. * @param id - Channel id */ getChannel(id: string): Promise<Channel>; /** * Retrieves notifications. */ getNotifications(): Promise<NotificationsMenu>; /** * Retrieves unseen notifications count. */ getUnseenNotificationsCount(): Promise<number>; /** * Retrieves playlist contents. * @param id - Playlist id */ getPlaylist(id: string): Promise<Playlist>; /** * Retrieves a given hashtag's page. * @param hashtag - The hashtag to fetch. */ getHashtag(hashtag: string): Promise<HashtagFeed>; /** * An alternative to {@link download}. * Returns deciphered streaming data. * * If you wish to retrieve the video info too, have a look at {@link getBasicInfo} or {@link getInfo}. * @param video_id - The video id. * @param options - Format options. */ getStreamingData(video_id: string, options?: FormatOptions): Promise<Format>; /** * Downloads a given video. If you only need the direct download link see {@link getStreamingData}. * If you wish to retrieve the video info too, have a look at {@link getBasicInfo} or {@link getInfo}. * @param video_id - The video id. * @param options - Download options. */ download(video_id: string, options?: DownloadOptions): Promise<ReadableStream<Uint8Array>>; /** * Resolves the given URL. * @param url - The URL. */ resolveURL(url: string): Promise<NavigationEndpoint>; /** * Utility method to call an endpoint without having to use {@link Actions}. * @param endpoint -The endpoint to call. * @param args - Call arguments. */ call<T extends IParsedResponse>(endpoint: NavigationEndpoint, args: { [key: string]: any; parse: true; }): Promise<T>; call(endpoint: NavigationEndpoint, args?: { [key: string]: any; parse?: false; }): Promise<ApiResponse>; /** * An interface for interacting with YouTube Music. */ get music(): Music; /** * An interface for interacting with YouTube Studio. */ get studio(): Studio; /** * An interface for interacting with YouTube Kids. */ get kids(): Kids; /** * An interface for managing and retrieving account information. */ get account(): AccountManager; /** * An interface for managing playlists. */ get playlist(): PlaylistManager; /** * An interface for directly interacting with certain YouTube features. */ get interact(): InteractionManager; /** * An internal class used to dispatch requests. */ get actions(): import("./core/Actions.js").default; /** * The session used by this instance. */ get session(): Session; }