diff --git a/.npmignore b/.npmignore index 98fb6412d..be7572efc 100644 --- a/.npmignore +++ b/.npmignore @@ -1,6 +1,7 @@ ** src/ +docs/ !dist/** !README.md !LICENSE diff --git a/README.md b/README.md index 7f56ea1ef..8dc8848e8 100644 --- a/README.md +++ b/README.md @@ -3,65 +3,30 @@ [versions]: https://www.npmjs.com/package/youtubei.js?activeTab=versions [codefactor]: https://www.codefactor.io/repository/github/luanrt/youtube.js [actions]: https://github.com/LuanRT/YouTube.js/actions -[collaborators]: https://github.com/LuanRT/YouTube.js/blob/main/COLLABORATORS.md - - -[project]: https://github.com/LuanRT/YouTube.js -[twitter]: https://twitter.com/thesciencephile [discord]: https://discord.gg/syDu7Yks54

- YouTube.js' Github Page + + YouTube.js Logo +

-

A JavaScript client for YouTube's private API, known as InnerTube.

+

A JavaScript client for YouTube's private API, known as InnerTube.

- [![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)][discord] - [![CI](https://github.com/LuanRT/YouTube.js/actions/workflows/test.yml/badge.svg)][actions] - [![NPM Version](https://img.shields.io/npm/v/youtubei.js?color=%2335C757)][versions] - [![Downloads](https://img.shields.io/npm/dt/youtubei.js)][npm] - [![Codefactor](https://www.codefactor.io/repository/github/luanrt/youtube.js/badge)][codefactor] +[![Discord](https://img.shields.io/badge/discord-online-brightgreen.svg)][discord] +[![CI](https://github.com/LuanRT/YouTube.js/actions/workflows/test.yml/badge.svg)][actions] +[![NPM Version](https://img.shields.io/npm/v/youtubei.js?color=%2335C757)][versions] +[![Downloads](https://img.shields.io/npm/dt/youtubei.js)][npm] +[![Codefactor](https://www.codefactor.io/repository/github/luanrt/youtube.js/badge)][codefactor] -
- Sponsored by    SerpApi - API to get search engine results with ease. -
-
-InnerTube is an API used by all YouTube clients. It was created to simplify the deployment of new features and experiments across the platform [^1]. This library manages all low-level communication with InnerTube, providing a simple and efficient way to interact with YouTube programmatically. Its design aims to closely emulate an actual client, including the parsing of API responses. - -If you have any questions or need help, feel free to reach out to us on our [Discord server][discord] or open an issue [here](https://github.com/LuanRT/YouTube.js/issues). - -### Table of Contents -
    -
  1. Prerequisites
    2. -
  2. Installation
    3. -
  3. - Usage - -
    4. -
  4. Contributing
    5. -
  5. Contact
    6. -
  6. Disclaimer
    7. -
  7. License
    8. -
- -### Prerequisites -YouTube.js runs on Node.js, Deno, and modern browsers. +YouTube.js is a JavaScript client for YouTube's internal API, known as "InnerTube". It allows you to interact with YouTube programmatically, providing access to videos, comments, live chats, streaming data and more. It works seamlessly across Node.js, Deno, and modern browsers. -It requires a runtime with the following features: -- [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) - - On Node, we use [undici](https://github.com/nodejs/undici)'s fetch implementation, which requires Node.js 16.8+. If you need to use an older version, you may provide your own fetch implementation. See [providing your own fetch implementation](#custom-fetch) for more information. - - The `Response` object returned by fetch must thus be spec compliant and return a `ReadableStream` object if you want to use the `VideoInfo#download` method. (Implementations like `node-fetch` return a non-standard `Readable` object.) -- [`EventTarget`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget) and [`CustomEvent`](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent) are required. +## Installation -### Installation +Before installing, make sure your environment meets the [prerequisites](https://ytjs.dev/guide/getting-started.html#prerequisites). ```bash # NPM @@ -74,709 +39,33 @@ yarn add youtubei.js@latest npm install github:LuanRT/YouTube.js ``` -When using Deno, you can import YouTube.js directly from deno.land: +Deno: ```ts import { Innertube } from 'https://deno.land/x/youtubei/deno.ts'; ``` -## Usage -Create an InnerTube instance: -```ts -// const { Innertube } = require('youtubei.js'); -import { Innertube } from 'youtubei.js'; -const youtube = await Innertube.create(/* options */); -``` - -### Options -
-Click to expand - -| Option | Type | Description | Default | -| --- | --- | --- | --- | -| `lang` | `string` | Language. | `en` | -| `location` | `string` | Geolocation. | `US` | -| `account_index` | `number` | The account index to use. This is useful if you have multiple accounts logged in. **NOTE:** Only works if you are signed in with cookies. | `0` | -| `visitor_data` | `string` | Setting this to a valid and persistent visitor data string will allow YouTube to give this session tailored content even when not logged in. A good way to get a valid one is by either grabbing it from a browser or calling InnerTube's `/visitor_id` endpoint. | `undefined` | -| `po_token` | `string` | Proof of Origin Token. This is an attestation token generated by BotGuard/DroidGuard. It is used to confirm that the request is coming from a genuine client. Valid tokens can be generated using [BgUtils](https://github.com/LuanRT/BgUtils) or [Invidious' tool](https://github.com/iv-org/youtube-trusted-session-generator). | `undefined` | -| `retrieve_player` | `boolean` | Specifies whether to retrieve the JS player. Disabling this will make session creation faster. **NOTE:** Deciphering formats is not possible without the JS player. | `true` | -| `enable_safety_mode` | `boolean` | Specifies whether to enable safety mode. This will prevent the session from loading any potentially unsafe content. | `false` | -| `generate_session_locally` | `boolean` | Specifies whether to generate the session data locally or retrieve it from YouTube. This can be useful if you need more performance. **NOTE:** If you are using the cache option and a session has already been generated, this will be ignored. If you want to force a new session to be generated, you must clear the cache or disable session caching. | `false` | -| `enable_session_cache` | `boolean` | Specifies whether to cache the session data. | `true` | -| `device_category` | `DeviceCategory` | Platform to use for the session. | `DESKTOP` | -| `client_type` | `ClientType` | InnerTube client type. It is not recommended to change this unless you know what you are doing. | `WEB` | -| `timezone` | `string` | The time zone. | `*` | -| `cache` | `ICache` | Used to cache algorithms, session data, and OAuth2 tokens. | `undefined` | -| `cookie` | `string` | YouTube cookies. | `undefined` | -| `fetch` | `FetchFunction` | Fetch function to use. | `fetch` | - - -
- -### Browser Usage -To use YouTube.js in the browser, you must proxy requests through your own server. You can see our simple reference implementation in Deno at [`examples/browser/proxy/deno.ts`](https://github.com/LuanRT/YouTube.js/tree/main/examples/browser/proxy/deno.ts). - -You may provide your own fetch implementation to be used by YouTube.js, which we will use to modify and send the requests through a proxy. See [`examples/browser/web`](https://github.com/LuanRT/YouTube.js/tree/main/examples/browser/web) for a simple example using [Vite](https://vitejs.dev/). - -```ts -// Multiple exports are available for the web. -// Unbundled ESM version -import { Innertube } from 'youtubei.js/web'; -// Bundled ESM version -// import { Innertube } from 'youtubei.js/web.bundle'; -// Production Bundled ESM version -// import { Innertube } from 'youtubei.js/web.bundle.min'; -await Innertube.create({ - fetch: async (input: RequestInfo | URL, init?: RequestInit) => { - // Modify the request - // and send it to the proxy - - // fetch the URL - return fetch(request, init); - } -}); -``` - -### Streaming -YouTube.js supports streaming of videos in the browser by converting YouTube's streaming data into an MPEG-DASH manifest. - -The example below uses [`dash.js`](https://github.com/Dash-Industry-Forum/dash.js) to play the video. - -```ts -import { Innertube } from 'youtubei.js/web'; -import dashjs from 'dashjs'; - -const youtube = await Innertube.create({ /* setup - see above */ }); - -// Get the video info -const videoInfo = await youtube.getInfo('videoId'); - -// now convert to a dash manifest -// again - to be able to stream the video in the browser - we must proxy the requests through our own server -// to do this, we provide a method to transform the URLs before writing them to the manifest -const manifest = await videoInfo.toDash(url => { - // modify the url - // and return it - return url; -}); - -const uri = "data:application/dash+xml;charset=utf-8;base64," + btoa(manifest); - -const videoElement = document.getElementById('video_player'); - -const player = dashjs.MediaPlayer().create(); -player.initialize(videoElement, uri, true); -``` - -A fully working example can be found in [`examples/browser/web`](https://github.com/LuanRT/YouTube.js/blob/main/examples/browser/web). - - - -### Providing your own fetch implementation -You may provide your own fetch implementation to be used by YouTube.js. This can be useful in some cases to modify the requests before they are sent and transform the responses before they are returned (eg. for proxies). -```ts -// provide a fetch implementation -const yt = await Innertube.create({ - fetch: async (input: RequestInfo | URL, init?: RequestInit) => { - // make the request with your own fetch implementation - // and return the response - return new Response( - /* ... */ - ); - } -}); -``` - - - -### Caching -Caching the transformed player instance can greatly improve the performance. Our `UniversalCache` implementation uses different caching methods depending on the environment. - -In Node.js, we use the `node:fs` module, `Deno.writeFile()` in Deno, and `indexedDB` in browsers. - -By default, the cache stores data in the operating system's temporary directory (or `indexedDB` in browsers). You can make this cache persistent by specifying the path to the cache directory, which will be created if it doesn't exist. - -```ts -import { Innertube, UniversalCache } from 'youtubei.js'; -// Create a cache that stores files in the OS temp directory (or indexedDB in browsers) by default. -const yt = await Innertube.create({ - cache: new UniversalCache(false) -}); - -// You may want to create a persistent cache instead (on Node and Deno). -const yt = await Innertube.create({ - cache: new UniversalCache( - // Enables persistent caching - true, - // Path to the cache directory. The directory will be created if it doesn't exist - './.cache' - ) -}); -``` - -### API - -* `Innertube` - -
- Properties -

- - * [.session](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/session.md) - * [.account](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/account.md) - * [.interact](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/interaction-manager.md) - * [.playlist](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/playlist.md) - * [.music](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/music.md) - * [.studio](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/studio.md) - * [.kids](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/kids.md) - -

-
- - -
- Methods -

- - * [.getInfo(target, client?)](#getinfo) - * [.getBasicInfo(video_id, client?)](#getbasicinfo) - * [.search(query, filters?)](#search) - * [.getSearchSuggestions(query)](#getsearchsuggestions) - * [.getComments(video_id, sort_by?)](#getcomments) - * [.getHomeFeed()](#gethomefeed) - * [.getGuide()](#getguide) - * [.getLibrary()](#getlibrary) - * [.getHistory()](#gethistory) - * [.getTrending()](#gettrending) - * [.getSubscriptionsFeed()](#getsubscriptionsfeed) - * [.getChannel(id)](#getchannel) - * [.getNotifications()](#getnotifications) - * [.getUnseenNotificationsCount()](#getunseennotificationscount) - * [.getPlaylist(id)](#getplaylist) - * [.getHashtag(hashtag)](#gethashtag) - * [.getStreamingData(video_id, options)](#getstreamingdata) - * [.download(video_id, options?)](#download) - * [.resolveURL(url)](#resolveurl) - * [.call(endpoint, args?)](#call) - -

-
- - -### `getInfo(target, client?)` - -Retrieves video info. - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| target | `string` \| `NavigationEndpoint` | If `string`, the id of the video. If `NavigationEndpoint`, the endpoint of watchable elements such as `Video`, `Mix` and `Playlist`. To clarify, valid endpoints have payloads containing at least `videoId` and optionally `playlistId`, `params` and `index`. | -| client? | `InnerTubeClient` | InnerTube client to use. | - -
-Methods & Getters -

- -- `#like()` - - Likes the video. - -- `#dislike()` - - Dislikes the video. - -- `#removeRating()` - - Removes like/dislike. - -- `#getLiveChat()` - - Returns a LiveChat instance. - -- `#getTrailerInfo()` - - Returns trailer info in a new `VideoInfo` instance, or `null` if none. Typically available for non-purchased movies or films. - -- `#chooseFormat(options)` - - Used to choose streaming data formats. - -- `#toDash(url_transformer?, format_filter?)` - - Converts streaming data to an MPEG-DASH manifest. - -- `#download(options)` - - Downloads the video. See [download](#download). - -- `#getTranscript()` - - Retrieves the video's transcript. - -- `#filters` - - Returns filters that can be applied to the watch next feed. - -- `#selectFilter(name)` - - Applies the given filter to the watch next feed and returns a new instance of [`VideoInfo`](https://github.com/LuanRT/YouTube.js/blob/main/src/parser/youtube/VideoInfo.ts). - -- `#getWatchNextContinuation()` - - Retrieves the next batch of items for the watch next feed. - -- `#addToWatchHistory()` - - Adds the video to the watch history. - -- `#autoplay_video_endpoint` - - Returns the endpoint of the video for Autoplay. - -- `#has_trailer` - - Checks if trailer is available. - -- `#page` - - Returns original InnerTube response (sanitized). - -

-
- - -### `getBasicInfo(video_id, client?)` - -Suitable for cases where you only need basic video metadata. Also, it is faster than [`getInfo()`](#getinfo). - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| video_id | `string` | The id of the video | -| client? | `InnerTubeClient` | InnerTube client to use. | - - -### `search(query, filters?)` - -Searches the given query on YouTube. - -**Returns**: `Promise` - -> **Note** -> `Search` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class. - -| Param | Type | Description | -| --- | --- | --- | -| query | `string` | The search query | -| filters? | `SearchFilters` | Search filters | - - -
-Search Filters - -| Filter | Type | Value | Description | -| --- | --- | --- | --- | -| upload_date | `string` | `all` \| `hour` \| `today` \| `week` \| `month` \| `year` | Filter by upload date | -| type | `string` | `all` \| `video` \| `channel` \| `playlist` \| `movie` | Filter by type | -| duration | `string` | `all` \| `short` \| `medium` \| `long` | Filter by duration | -| sort_by | `string` | `relevance` \| `rating` \| `upload_date` \| `view_count` | Sort by | -| features | `string[]` | `hd` \| `subtitles` \| `creative_commons` \| `3d` \| `live` \| `purchased` \| `4k` \| `360` \| `location` \| `hdr` \| `vr180` | Filter by features | - -
- -
-Methods & Getters -

- -- `#selectRefinementCard(SearchRefinementCard | string)` - - Applies given refinement card and returns a new Search instance. - -- `#refinement_card_queries` - - Returns available refinement cards, this is a simplified version of the `refinement_cards` object. - -- `#getContinuation()` - - Retrieves next batch of results. - -

-
- - -### `getSearchSuggestions(query)` -Retrieves search suggestions for given query. - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| query | `string` | The search query | - - -### `getComments(video_id, sort_by?)` -Retrieves comments for given video. - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| video_id | `string` | The video id | -| sort_by | `string` | Can be: `TOP_COMMENTS` or `NEWEST_FIRST` | - -See [`./examples/comments`](https://github.com/LuanRT/YouTube.js/blob/main/examples/comments) for examples. - - -### `getHomeFeed()` -Retrieves YouTube's home feed. - -**Returns**: `Promise` - -> **Note** -> `HomeFeed` extends the [`FilterableFeed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/filterable-feed.md) class. - -
-Methods & Getters -

- -- `#videos` - - Returns all videos in the home feed. - -- `#posts` - - Returns all posts in the home feed. - -- `#shelves` - - Returns all shelves in the home feed. - -- `#filters` - - Returns available filters. - -- `#applyFilter(name | ChipCloudChip)` - - Applies given filter and returns a new HomeFeed instance. - -- `#getContinuation()` - - Retrieves feed continuation. - -

-
- - -### `getGuide()` -Retrieves YouTube's content guide. - -**Returns**: `Promise` - - -### `getLibrary()` -Retrieves the account's library. - -**Returns**: `Promise` - -> **Note** -> `Library` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class. - -
-Methods & Getters -

- -- `#history` -- `#watch_later` -- `#liked_videos` -- `#playlists_section` -- `#clips` - -

-
- - -### `getHistory()` -Retrieves watch history. - -**Returns**: `Promise` - -> **Note** -> `History` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class. - -
-Methods & Getters -

- -- `#getContinuation()` - - Retrieves next batch of contents. - -

-
- - -### `getTrending()` -Retrieves trending content. - -**Returns**: `Promise>` - - -### `getSubscriptionsFeed()` -Retrieves the subscriptions feed. - -**Returns**: `Promise>` - - -### `getChannel(id)` -Retrieves contents for a given channel. - -**Returns**: `Promise` - -> **Note** -> `Channel` extends the [`TabbedFeed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/tabbed-feed.md) class. - -| Param | Type | Description | -| --- | --- | --- | -| id | `string` | Channel id | - -
-Methods & Getters -

- -- `#getVideos()` -- `#getShorts()` -- `#getLiveStreams()` -- `#getReleases()` -- `#getPodcasts()` -- `#getPlaylists()` -- `#getHome()` -- `#getCommunity()` -- `#getChannels()` -- `#getAbout()` -- `#search(query)` -- `#applyFilter(filter)` -- `#applyContentTypeFilter(content_type_filter)` -- `#applySort(sort)` -- `#getContinuation()` -- `#filters` -- `#content_type_filters` -- `#sort_filters` -- `#page` - -

-
- -See [`./examples/channel`](https://github.com/LuanRT/YouTube.js/blob/main/examples/channel) for examples. - - -### `getNotifications()` -Retrieves notifications. - -**Returns**: `Promise` - -
-Methods & Getter -

- -- `#getContinuation()` - - Retrieves next batch of notifications. - -

-
- - -### `getUnseenNotificationsCount()` -Retrieves unseen notifications count. - -**Returns**: `Promise` - - -### `getPlaylist(id)` -Retrieves playlist contents. - -**Returns**: `Promise` - -> **Note** -> `Playlist` extends the [`Feed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/feed.md) class. - -| Param | Type | Description | -| --- | --- | --- | -| id | `string` | Playlist id | - -
-Methods & Getter -

- -- `#items` - - Returns the items of the playlist. - -

-
- - -### `getHashtag(hashtag)` -Retrieves a given hashtag's page. - -**Returns**: `Promise` - -> **Note** -> `HashtagFeed` extends the [`FilterableFeed`](https://github.com/LuanRT/YouTube.js/blob/main/docs/API/filterable-feed.md) class. - -| Param | Type | Description | -| --- | --- | --- | -| hashtag | `string` | The hashtag | - -
-Methods & Getter -

- -- `#applyFilter(filter)` - - Applies given filter and returns a new `HashtagFeed` instance. -- `#getContinuation()` - - Retrieves next batch of contents. - -

-
- - -### `getStreamingData(video_id, options)` -Returns deciphered streaming data. - -> **Note** -> This method will be deprecated in the future. We recommend retrieving streaming data from a `VideoInfo` or `TrackInfo` object instead if you want to select formats manually. Please refer to the following example: - -```ts -const info = await yt.getBasicInfo('somevideoid'); - -const url = info.streaming_data?.formats[0].decipher(yt.session.player); -console.info('Playback url:', url); - -// or: -const format = info.chooseFormat({ type: 'audio', quality: 'best' }); -const url = format?.decipher(yt.session.player); -console.info('Playback url:', url); -``` - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| video_id | `string` | Video id | -| options | `FormatOptions` | Format options | - - -### `download(video_id, options?)` -Downloads a given video. - -**Returns**: `Promise>` +## Basic Usage -| Param | Type | Description | -| --- | --- | --- | -| video_id | `string` | Video id | -| options | `DownloadOptions` | Download options | - -See [`./examples/download`](https://github.com/LuanRT/YouTube.js/blob/main/examples/download) for examples. - - -### `resolveURL(url)` -Resolves a given url. - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| url | `string` | Url to resolve | - - -### `call(endpoint, args?)` -Utility to call navigation endpoints. - -**Returns**: `Promise` - -| Param | Type | Description | -| --- | --- | --- | -| endpoint | `NavigationEndpoint` | The target endpoint | -| args? | `object` | Additional payload arguments | - -### Extending the library - -YouTube.js is modular and easy to extend. Most of the methods, classes, and utilities used internally are exposed and can be used to implement your own extensions without having to modify the library's source code. - -For example, let's say we want to implement a method to retrieve video info. We can do that by using an instance of the `Actions` class: ```ts +// const { Innertube } = require('youtubei.js'); import { Innertube } from 'youtubei.js'; - -(async () => { - const yt = await Innertube.create(); - - async function getVideoInfo(videoId: string) { - const videoInfo = await yt.actions.execute('/player', { - // You can add any additional payloads here, and they'll merge with the default payload sent to InnerTube. - videoId, - client: 'YTMUSIC', // InnerTube client to use. - parse: true // tells YouTube.js to parse the response (not sent to InnerTube). - }); - - return videoInfo; - } - - const videoInfo = await getVideoInfo('jLTOuvBTLxA'); - console.info(videoInfo); -})(); -``` - -Alternatively, suppose we locate a `NavigationEndpoint` in a parsed response and want to see what happens when we call it: -```ts -import { Innertube, YTNodes } from 'youtubei.js'; - -(async () => { - const yt = await Innertube.create(); - - const artist = await yt.music.getArtist('UC52ZqHVQz5OoGhvbWiRal6g'); - const albums = artist.sections[1].as(YTNodes.MusicCarouselShelf); - - // Let's imagine that we wish to click on the β€œMore” button: - const button = albums.as(YTNodes.MusicCarouselShelf).header?.more_content; - - if (button) { - // Having ensured that it exists, we can then call its navigation endpoint using the following code: - const page = await button.endpoint.call(yt.actions, { parse: true }); - console.info(page); - } -})(); -``` - -### Parser - -YouTube.js' parser enables you to parse InnerTube responses and convert their nodes into strongly-typed objects that are simple to manipulate. Additionally, it provides numerous utility methods that make working with InnerTube a breeze. - -Here's an example of its usage: -```ts -// See ./examples/parser - -import { Parser, YTNodes } from 'youtubei.js'; -import { readFileSync } from 'fs'; - -// YouTube Music's artist page response -const data = readFileSync('./artist.json').toString(); - -const page = Parser.parseResponse(JSON.parse(data)); - -const header = page.header?.item().as(YTNodes.MusicImmersiveHeader, YTNodes.MusicVisualHeader); - -console.info('Header:', header); - -// The parser uses a proxy object to add type safety and utility methods for working with InnerTube's data arrays: -const tab = page.contents?.item().as(YTNodes.SingleColumnBrowseResults).tabs.firstOfType(YTNodes.Tab); - -if (!tab) - throw new Error('Target tab not found'); - -if (!tab.content) - throw new Error('Target tab appears to be empty'); - -const sections = tab.content?.as(YTNodes.SectionList).contents.as(YTNodes.MusicCarouselShelf, YTNodes.MusicDescriptionShelf, YTNodes.MusicShelf); - -console.info('Sections:', sections); +const innertube = await Innertube.create(/* options */); ``` -Documentation for the parser can be found [here](https://github.com/LuanRT/YouTube.js/blob/main/src/parser). +For detailed usage, check out the [YouTube.js Guide and API Documentation](https://ytjs.dev). ## Contributing We welcome all contributions, issues and feature requests, whether small or large. If you want to contribute, feel free to check out our [issues page](https://github.com/LuanRT/YouTube.js/issues) and our [guidelines](https://github.com/LuanRT/YouTube.js/blob/main/CONTRIBUTING.md). -We are immensely grateful to all the wonderful people who have contributed to this project. A special shoutout to all our contributors! πŸŽ‰ +## Contributors -## Contact - -LuanRT - [@thesciencephile][twitter] - luanrt@thatsciencephile.com - -Project Link: [https://github.com/LuanRT/YouTube.js][project] - ## Disclaimer This project is not affiliated with, endorsed, or sponsored by YouTube or any of its affiliates or subsidiaries. All trademarks, logos, and brand names used in this project are the property of their respective owners and are used solely to describe the services provided. -As such, any usage of trademarks to refer to such services is considered nominative use. If you have any questions or concerns, please contact me directly via email. - -[^1]: https://gizmodo.com/how-project-innertube-helped-pull-youtube-out-of-the-gu-1704946491 +As such, any usage of trademarks to refer to such services is considered nominative use. If you have any questions or concerns, please contact me. ## License Distributed under the [MIT](https://choosealicense.com/licenses/mit/) License. diff --git a/docs/API/account.md b/docs/API/account.md deleted file mode 100644 index 8161d3893..000000000 --- a/docs/API/account.md +++ /dev/null @@ -1,115 +0,0 @@ -# Account - -YouTube account manager. - -## API - -* Account - * [.channel](#channel) - * [.getInfo()](#getinfo) - * [.getTimeWatched()](#gettimewatched) - * [.getSettings()](#getsettings) - * [.getAnalytics](#getanalytics) - - -### channel - -Channel settings. - -**Returns:** `object` - -
-Methods & Getters -

- -- `#editName(new_name)` - - Edits the name of the channel. - -- `#editDescription(new_description)` - - Edits channel description. - -- `#getBasicAnalytics()` - - Alias for [`Account#getAnalytics()`](#getanalytics) β€” returns basic channel analytics. - -

-
- - -### getInfo() - -Retrieves account information. - -**Returns:** `Promise.` - -
-Methods & Getters -

- -- `#page` - - Returns the original InnerTube response(s), parsed and sanitized. - -

-
- - -### getTimeWatched() - -Retrieves time watched statistics. - -**Returns:** `Promise.` - -
-Methods & Getters -

- -- `#page` - - Returns the original InnerTube response(s), parsed and sanitized. - -

-
- - -### getSettings() - -Retrieves YouTube settings. - -**Returns:** `Promise.` - -
-Methods & Getters -

- -- `#selectSidebarItem(name)` - - Selects an item from the sidebar menu. Use `settings#sidebar_items` to see available items. - -- `#getSettingOption(name)` - - Finds a setting by name and returns it. Use `settings#setting_options` to see available options. - -- `#setting_options` - - Returns settings available in the page. - -- `#sidebar_items` - - Returns options available in the sidebar menu. - -- `#page` - - Returns the original InnerTube response(s), parsed and sanitized. - -

-
- - -### getAnalytics() - -Retrieves basic channel analytics. - -**Returns:** `Promise.` - -
-Methods & Getters -

- -- `#page` - - Returns the original InnerTube response(s), parsed and sanitized. - -

-
\ No newline at end of file diff --git a/docs/API/feed.md b/docs/API/feed.md deleted file mode 100644 index 13c7e4b35..000000000 --- a/docs/API/feed.md +++ /dev/null @@ -1,115 +0,0 @@ -# Feed - -Represents a YouTube feed. This class provides a set of utility methods for parsing and interacting with feeds. - -## API - -* Feed - * [.videos](#videos) - * [.posts](#posts) - * [.channels](#channels) - * [.playlists](#playlists) - * [.shelves](#shelves) - * [.memo](#memo) - * [.page_contents](#page_contents) - * [.secondary_contents](#secondary_contents) - * [.page](#page) - * [.has_continuation](#has_continuation) - * [.getContinuationData()](#getcontinuationdata) - * [.getContinuation()](#getcontinuation) - * [.getShelf(title)](#getshelf) - - -### videos - -Returns all videos in the feed. - -**Returns:** `ObservedArray