From be6758fac258473d23407b2715359e3159e4870c Mon Sep 17 00:00:00 2001 From: semantic-release-bot Date: Sat, 18 Jan 2025 21:37:15 +0000 Subject: [PATCH] chore(release): 0.2.0 [skip ci] # [0.2.0](https://github.com/suzuki3jp/youtubes.js/compare/v0.1.2...v0.2.0) (2025-01-18) ### Features * **ci:** Add API documentation generation to release workflow ([85dd586](https://github.com/suzuki3jp/youtubes.js/commit/85dd586c2ddcd30f3270f16bf5473327b8fc5ffe)) --- CHANGELOG.md | 7 + docs/api/index.md | 29 ++ .../youtubes.js.apiclient._constructor_.md | 47 +++ docs/api/youtubes.js.apiclient.md | 91 ++++++ docs/api/youtubes.js.apiclient.playlists.md | 13 + .../youtubes.js.apiclientoptions.loglevel.md | 13 + docs/api/youtubes.js.apiclientoptions.md | 74 +++++ .../api/youtubes.js.apiclientoptions.oauth.md | 13 + ...s.createplaylistoptions.defaultlanguage.md | 13 + ...es.js.createplaylistoptions.description.md | 13 + ....js.createplaylistoptions.localizations.md | 16 + docs/api/youtubes.js.createplaylistoptions.md | 131 ++++++++ ...utubes.js.createplaylistoptions.privacy.md | 13 + ...youtubes.js.createplaylistoptions.title.md | 13 + docs/api/youtubes.js.loglevel.md | 11 + docs/api/youtubes.js.md | 196 ++++++++++++ docs/api/youtubes.js.oauthproviders.md | 13 + .../youtubes.js.pagination._constructor_.md | 47 +++ docs/api/youtubes.js.pagination.all.md | 34 +++ docs/api/youtubes.js.pagination.data.md | 13 + docs/api/youtubes.js.pagination.md | 191 ++++++++++++ docs/api/youtubes.js.pagination.next.md | 36 +++ docs/api/youtubes.js.pagination.prev.md | 36 +++ .../youtubes.js.pagination.resultsperpage.md | 13 + .../youtubes.js.pagination.totalresults.md | 13 + .../api/youtubes.js.paginationoptions.data.md | 11 + ...tubes.js.paginationoptions.getwithtoken.md | 11 + .../youtubes.js.paginationoptions.logger.md | 11 + docs/api/youtubes.js.paginationoptions.md | 163 ++++++++++ ...youtubes.js.paginationoptions.nexttoken.md | 11 + ...youtubes.js.paginationoptions.prevtoken.md | 11 + ...bes.js.paginationoptions.resultsperpage.md | 11 + ...tubes.js.paginationoptions.totalresults.md | 11 + .../api/youtubes.js.playlist._constructor_.md | 47 +++ docs/api/youtubes.js.playlist.channelid.md | 13 + docs/api/youtubes.js.playlist.channelname.md | 13 + docs/api/youtubes.js.playlist.count.md | 13 + docs/api/youtubes.js.playlist.description.md | 13 + docs/api/youtubes.js.playlist.from.md | 63 ++++ docs/api/youtubes.js.playlist.id.md | 13 + docs/api/youtubes.js.playlist.md | 279 ++++++++++++++++++ docs/api/youtubes.js.playlist.privacy.md | 13 + docs/api/youtubes.js.playlist.publishedat.md | 13 + docs/api/youtubes.js.playlist.thumbnails.md | 13 + docs/api/youtubes.js.playlist.title.md | 13 + ...utubes.js.playlistmanager._constructor_.md | 47 +++ .../api/youtubes.js.playlistmanager.create.md | 55 ++++ .../youtubes.js.playlistmanager.deletebyid.md | 55 ++++ ...tubes.js.playlistmanager.getbychannelid.md | 86 ++++++ .../youtubes.js.playlistmanager.getbyids.md | 86 ++++++ .../youtubes.js.playlistmanager.getmine.md | 70 +++++ docs/api/youtubes.js.playlistmanager.md | 149 ++++++++++ docs/api/youtubes.js.privacy.md | 11 + ...utubes.js.staticcredentials.accesstoken.md | 11 + docs/api/youtubes.js.staticcredentials.md | 55 ++++ ...es.js.staticoauthprovider._constructor_.md | 47 +++ ...s.js.staticoauthprovider.getnativeoauth.md | 15 + docs/api/youtubes.js.staticoauthprovider.md | 80 +++++ docs/api/youtubes.js.thumbnail.height.md | 13 + docs/api/youtubes.js.thumbnail.md | 93 ++++++ docs/api/youtubes.js.thumbnail.url.md | 13 + docs/api/youtubes.js.thumbnail.width.md | 13 + .../youtubes.js.thumbnails._constructor_.md | 47 +++ docs/api/youtubes.js.thumbnails.default.md | 11 + docs/api/youtubes.js.thumbnails.from.md | 67 +++++ ...ubes.js.thumbnails.gethighestresolution.md | 19 ++ ...tubes.js.thumbnails.getlowestresolution.md | 19 ++ docs/api/youtubes.js.thumbnails.high.md | 11 + docs/api/youtubes.js.thumbnails.maxres.md | 11 + docs/api/youtubes.js.thumbnails.md | 233 +++++++++++++++ docs/api/youtubes.js.thumbnails.medium.md | 11 + docs/api/youtubes.js.thumbnails.standard.md | 11 + package-lock.json | 4 +- package.json | 2 +- 74 files changed, 3177 insertions(+), 3 deletions(-) create mode 100644 docs/api/index.md create mode 100644 docs/api/youtubes.js.apiclient._constructor_.md create mode 100644 docs/api/youtubes.js.apiclient.md create mode 100644 docs/api/youtubes.js.apiclient.playlists.md create mode 100644 docs/api/youtubes.js.apiclientoptions.loglevel.md create mode 100644 docs/api/youtubes.js.apiclientoptions.md create mode 100644 docs/api/youtubes.js.apiclientoptions.oauth.md create mode 100644 docs/api/youtubes.js.createplaylistoptions.defaultlanguage.md create mode 100644 docs/api/youtubes.js.createplaylistoptions.description.md create mode 100644 docs/api/youtubes.js.createplaylistoptions.localizations.md create mode 100644 docs/api/youtubes.js.createplaylistoptions.md create mode 100644 docs/api/youtubes.js.createplaylistoptions.privacy.md create mode 100644 docs/api/youtubes.js.createplaylistoptions.title.md create mode 100644 docs/api/youtubes.js.loglevel.md create mode 100644 docs/api/youtubes.js.md create mode 100644 docs/api/youtubes.js.oauthproviders.md create mode 100644 docs/api/youtubes.js.pagination._constructor_.md create mode 100644 docs/api/youtubes.js.pagination.all.md create mode 100644 docs/api/youtubes.js.pagination.data.md create mode 100644 docs/api/youtubes.js.pagination.md create mode 100644 docs/api/youtubes.js.pagination.next.md create mode 100644 docs/api/youtubes.js.pagination.prev.md create mode 100644 docs/api/youtubes.js.pagination.resultsperpage.md create mode 100644 docs/api/youtubes.js.pagination.totalresults.md create mode 100644 docs/api/youtubes.js.paginationoptions.data.md create mode 100644 docs/api/youtubes.js.paginationoptions.getwithtoken.md create mode 100644 docs/api/youtubes.js.paginationoptions.logger.md create mode 100644 docs/api/youtubes.js.paginationoptions.md create mode 100644 docs/api/youtubes.js.paginationoptions.nexttoken.md create mode 100644 docs/api/youtubes.js.paginationoptions.prevtoken.md create mode 100644 docs/api/youtubes.js.paginationoptions.resultsperpage.md create mode 100644 docs/api/youtubes.js.paginationoptions.totalresults.md create mode 100644 docs/api/youtubes.js.playlist._constructor_.md create mode 100644 docs/api/youtubes.js.playlist.channelid.md create mode 100644 docs/api/youtubes.js.playlist.channelname.md create mode 100644 docs/api/youtubes.js.playlist.count.md create mode 100644 docs/api/youtubes.js.playlist.description.md create mode 100644 docs/api/youtubes.js.playlist.from.md create mode 100644 docs/api/youtubes.js.playlist.id.md create mode 100644 docs/api/youtubes.js.playlist.md create mode 100644 docs/api/youtubes.js.playlist.privacy.md create mode 100644 docs/api/youtubes.js.playlist.publishedat.md create mode 100644 docs/api/youtubes.js.playlist.thumbnails.md create mode 100644 docs/api/youtubes.js.playlist.title.md create mode 100644 docs/api/youtubes.js.playlistmanager._constructor_.md create mode 100644 docs/api/youtubes.js.playlistmanager.create.md create mode 100644 docs/api/youtubes.js.playlistmanager.deletebyid.md create mode 100644 docs/api/youtubes.js.playlistmanager.getbychannelid.md create mode 100644 docs/api/youtubes.js.playlistmanager.getbyids.md create mode 100644 docs/api/youtubes.js.playlistmanager.getmine.md create mode 100644 docs/api/youtubes.js.playlistmanager.md create mode 100644 docs/api/youtubes.js.privacy.md create mode 100644 docs/api/youtubes.js.staticcredentials.accesstoken.md create mode 100644 docs/api/youtubes.js.staticcredentials.md create mode 100644 docs/api/youtubes.js.staticoauthprovider._constructor_.md create mode 100644 docs/api/youtubes.js.staticoauthprovider.getnativeoauth.md create mode 100644 docs/api/youtubes.js.staticoauthprovider.md create mode 100644 docs/api/youtubes.js.thumbnail.height.md create mode 100644 docs/api/youtubes.js.thumbnail.md create mode 100644 docs/api/youtubes.js.thumbnail.url.md create mode 100644 docs/api/youtubes.js.thumbnail.width.md create mode 100644 docs/api/youtubes.js.thumbnails._constructor_.md create mode 100644 docs/api/youtubes.js.thumbnails.default.md create mode 100644 docs/api/youtubes.js.thumbnails.from.md create mode 100644 docs/api/youtubes.js.thumbnails.gethighestresolution.md create mode 100644 docs/api/youtubes.js.thumbnails.getlowestresolution.md create mode 100644 docs/api/youtubes.js.thumbnails.high.md create mode 100644 docs/api/youtubes.js.thumbnails.maxres.md create mode 100644 docs/api/youtubes.js.thumbnails.md create mode 100644 docs/api/youtubes.js.thumbnails.medium.md create mode 100644 docs/api/youtubes.js.thumbnails.standard.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 8b1f33e..7d5963e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +# [0.2.0](https://github.com/suzuki3jp/youtubes.js/compare/v0.1.2...v0.2.0) (2025-01-18) + + +### Features + +* **ci:** Add API documentation generation to release workflow ([85dd586](https://github.com/suzuki3jp/youtubes.js/commit/85dd586c2ddcd30f3270f16bf5473327b8fc5ffe)) + ## [0.1.2](https://github.com/suzuki3jp/youtubes.js/compare/v0.1.1...v0.1.2) (2025-01-18) diff --git a/docs/api/index.md b/docs/api/index.md new file mode 100644 index 0000000..e4dbdcf --- /dev/null +++ b/docs/api/index.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + + + +
+ +Package + + + + +Description + + +
+ +[youtubes.js](./youtubes.js.md) + + + + + +
diff --git a/docs/api/youtubes.js.apiclient._constructor_.md b/docs/api/youtubes.js.apiclient._constructor_.md new file mode 100644 index 0000000..98909c2 --- /dev/null +++ b/docs/api/youtubes.js.apiclient._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClient](./youtubes.js.apiclient.md) > [(constructor)](./youtubes.js.apiclient._constructor_.md) + +## ApiClient.(constructor) + +Constructs a new instance of the `ApiClient` class + +**Signature:** + +```typescript +constructor({ oauth, logLevel }: ApiClientOptions); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +{ oauth, logLevel } + + + + +[ApiClientOptions](./youtubes.js.apiclientoptions.md) + + + + + +
diff --git a/docs/api/youtubes.js.apiclient.md b/docs/api/youtubes.js.apiclient.md new file mode 100644 index 0000000..29aebec --- /dev/null +++ b/docs/api/youtubes.js.apiclient.md @@ -0,0 +1,91 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClient](./youtubes.js.apiclient.md) + +## ApiClient class + +The main class for interacting with the YouTube Data API. + +**Signature:** + +```typescript +export declare class ApiClient +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)({ oauth, logLevel })](./youtubes.js.apiclient._constructor_.md) + + + + + + + +Constructs a new instance of the `ApiClient` class + + +
+ +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[playlists](./youtubes.js.apiclient.playlists.md) + + + + + + + +[PlaylistManager](./youtubes.js.playlistmanager.md) + + + + +The manager for playlists. Provides methods for fetching and manipulating playlists. + + +
diff --git a/docs/api/youtubes.js.apiclient.playlists.md b/docs/api/youtubes.js.apiclient.playlists.md new file mode 100644 index 0000000..3437152 --- /dev/null +++ b/docs/api/youtubes.js.apiclient.playlists.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClient](./youtubes.js.apiclient.md) > [playlists](./youtubes.js.apiclient.playlists.md) + +## ApiClient.playlists property + +The manager for playlists. Provides methods for fetching and manipulating playlists. + +**Signature:** + +```typescript +playlists: PlaylistManager; +``` diff --git a/docs/api/youtubes.js.apiclientoptions.loglevel.md b/docs/api/youtubes.js.apiclientoptions.loglevel.md new file mode 100644 index 0000000..2fc67ee --- /dev/null +++ b/docs/api/youtubes.js.apiclientoptions.loglevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClientOptions](./youtubes.js.apiclientoptions.md) > [logLevel](./youtubes.js.apiclientoptions.loglevel.md) + +## ApiClientOptions.logLevel property + +The log level for the client. + +**Signature:** + +```typescript +logLevel?: LogLevel; +``` diff --git a/docs/api/youtubes.js.apiclientoptions.md b/docs/api/youtubes.js.apiclientoptions.md new file mode 100644 index 0000000..37d59c6 --- /dev/null +++ b/docs/api/youtubes.js.apiclientoptions.md @@ -0,0 +1,74 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClientOptions](./youtubes.js.apiclientoptions.md) + +## ApiClientOptions interface + +**Signature:** + +```typescript +export interface ApiClientOptions +``` + +## Properties + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[logLevel?](./youtubes.js.apiclientoptions.loglevel.md) + + + + + + + +[LogLevel](./youtubes.js.loglevel.md) + + + + +_(Optional)_ The log level for the client. + + +
+ +[oauth](./youtubes.js.apiclientoptions.oauth.md) + + + + + + + +[OAuthProviders](./youtubes.js.oauthproviders.md) + + + + +The OAuth providers to use. + + +
diff --git a/docs/api/youtubes.js.apiclientoptions.oauth.md b/docs/api/youtubes.js.apiclientoptions.oauth.md new file mode 100644 index 0000000..e5d62ac --- /dev/null +++ b/docs/api/youtubes.js.apiclientoptions.oauth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClientOptions](./youtubes.js.apiclientoptions.md) > [oauth](./youtubes.js.apiclientoptions.oauth.md) + +## ApiClientOptions.oauth property + +The OAuth providers to use. + +**Signature:** + +```typescript +oauth: OAuthProviders; +``` diff --git a/docs/api/youtubes.js.createplaylistoptions.defaultlanguage.md b/docs/api/youtubes.js.createplaylistoptions.defaultlanguage.md new file mode 100644 index 0000000..344031f --- /dev/null +++ b/docs/api/youtubes.js.createplaylistoptions.defaultlanguage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) > [defaultLanguage](./youtubes.js.createplaylistoptions.defaultlanguage.md) + +## CreatePlaylistOptions.defaultLanguage property + +The language of the playlist's default metadata. + +**Signature:** + +```typescript +defaultLanguage?: string; +``` diff --git a/docs/api/youtubes.js.createplaylistoptions.description.md b/docs/api/youtubes.js.createplaylistoptions.description.md new file mode 100644 index 0000000..f0e2342 --- /dev/null +++ b/docs/api/youtubes.js.createplaylistoptions.description.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) > [description](./youtubes.js.createplaylistoptions.description.md) + +## CreatePlaylistOptions.description property + +The description of the playlist. + +**Signature:** + +```typescript +description?: string; +``` diff --git a/docs/api/youtubes.js.createplaylistoptions.localizations.md b/docs/api/youtubes.js.createplaylistoptions.localizations.md new file mode 100644 index 0000000..9bd5a19 --- /dev/null +++ b/docs/api/youtubes.js.createplaylistoptions.localizations.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) > [localizations](./youtubes.js.createplaylistoptions.localizations.md) + +## CreatePlaylistOptions.localizations property + +The localized metadata for the playlist. + +**Signature:** + +```typescript +localizations?: Record; +``` diff --git a/docs/api/youtubes.js.createplaylistoptions.md b/docs/api/youtubes.js.createplaylistoptions.md new file mode 100644 index 0000000..e196a30 --- /dev/null +++ b/docs/api/youtubes.js.createplaylistoptions.md @@ -0,0 +1,131 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) + +## CreatePlaylistOptions interface + +**Signature:** + +```typescript +export interface CreatePlaylistOptions +``` + +## Properties + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[defaultLanguage?](./youtubes.js.createplaylistoptions.defaultlanguage.md) + + + + + + + +string + + + + +_(Optional)_ The language of the playlist's default metadata. + + +
+ +[description?](./youtubes.js.createplaylistoptions.description.md) + + + + + + + +string + + + + +_(Optional)_ The description of the playlist. + + +
+ +[localizations?](./youtubes.js.createplaylistoptions.localizations.md) + + + + + + + +Record<string, { title: string; description: string; }> + + + + +_(Optional)_ The localized metadata for the playlist. + + +
+ +[privacy?](./youtubes.js.createplaylistoptions.privacy.md) + + + + + + + +[Privacy](./youtubes.js.privacy.md) + + + + +_(Optional)_ The privacy status of the playlist. + + +
+ +[title](./youtubes.js.createplaylistoptions.title.md) + + + + + + + +string + + + + +The title of the playlist. + + +
diff --git a/docs/api/youtubes.js.createplaylistoptions.privacy.md b/docs/api/youtubes.js.createplaylistoptions.privacy.md new file mode 100644 index 0000000..0a08d90 --- /dev/null +++ b/docs/api/youtubes.js.createplaylistoptions.privacy.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) > [privacy](./youtubes.js.createplaylistoptions.privacy.md) + +## CreatePlaylistOptions.privacy property + +The privacy status of the playlist. + +**Signature:** + +```typescript +privacy?: Privacy; +``` diff --git a/docs/api/youtubes.js.createplaylistoptions.title.md b/docs/api/youtubes.js.createplaylistoptions.title.md new file mode 100644 index 0000000..5820793 --- /dev/null +++ b/docs/api/youtubes.js.createplaylistoptions.title.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) > [title](./youtubes.js.createplaylistoptions.title.md) + +## CreatePlaylistOptions.title property + +The title of the playlist. + +**Signature:** + +```typescript +title: string; +``` diff --git a/docs/api/youtubes.js.loglevel.md b/docs/api/youtubes.js.loglevel.md new file mode 100644 index 0000000..bbb9896 --- /dev/null +++ b/docs/api/youtubes.js.loglevel.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [LogLevel](./youtubes.js.loglevel.md) + +## LogLevel type + +**Signature:** + +```typescript +export type LogLevel = "ERROR" | "INFO" | "DEBUG"; +``` diff --git a/docs/api/youtubes.js.md b/docs/api/youtubes.js.md new file mode 100644 index 0000000..ab87414 --- /dev/null +++ b/docs/api/youtubes.js.md @@ -0,0 +1,196 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) + +## youtubes.js package + +## Classes + + + + + + + + +
+ +Class + + + + +Description + + +
+ +[ApiClient](./youtubes.js.apiclient.md) + + + + +The main class for interacting with the YouTube Data API. + + +
+ +[Pagination](./youtubes.js.pagination.md) + + + + +Provides utility methods for pagination. + + +
+ +[Playlist](./youtubes.js.playlist.md) + + + + +Represents a YouTube playlist resource. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists\#resource) + + +
+ +[PlaylistManager](./youtubes.js.playlistmanager.md) + + + + +Manager for playlist endpoints. Provides methods for `/youtube/v3/playlists`. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists) + + +
+ +[StaticOAuthProvider](./youtubes.js.staticoauthprovider.md) + + + + +An OAuth provider that doesn't refresh the token + + +
+ +[Thumbnails](./youtubes.js.thumbnails.md) + + + + +Presents the thumbnails of the video or the playlist. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/thumbnails) + + +
+ +## Interfaces + + + + + + + +
+ +Interface + + + + +Description + + +
+ +[ApiClientOptions](./youtubes.js.apiclientoptions.md) + + + + + +
+ +[CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) + + + + + +
+ +[PaginationOptions](./youtubes.js.paginationoptions.md) + + + + + +
+ +[StaticCredentials](./youtubes.js.staticcredentials.md) + + + + +The credentials for a `StaticOAuthProvider` + + +
+ +[Thumbnail](./youtubes.js.thumbnail.md) + + + + + +
+ +## Type Aliases + + + + + +
+ +Type Alias + + + + +Description + + +
+ +[LogLevel](./youtubes.js.loglevel.md) + + + + + +
+ +[OAuthProviders](./youtubes.js.oauthproviders.md) + + + + + +
+ +[Privacy](./youtubes.js.privacy.md) + + + + + +
diff --git a/docs/api/youtubes.js.oauthproviders.md b/docs/api/youtubes.js.oauthproviders.md new file mode 100644 index 0000000..32ec1d5 --- /dev/null +++ b/docs/api/youtubes.js.oauthproviders.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [OAuthProviders](./youtubes.js.oauthproviders.md) + +## OAuthProviders type + +**Signature:** + +```typescript +export type OAuthProviders = StaticOAuthProvider; +``` +**References:** [StaticOAuthProvider](./youtubes.js.staticoauthprovider.md) + diff --git a/docs/api/youtubes.js.pagination._constructor_.md b/docs/api/youtubes.js.pagination._constructor_.md new file mode 100644 index 0000000..eef04a5 --- /dev/null +++ b/docs/api/youtubes.js.pagination._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [(constructor)](./youtubes.js.pagination._constructor_.md) + +## Pagination.(constructor) + +Constructs a new instance of the `Pagination` class + +**Signature:** + +```typescript +constructor({ data, logger, prevToken, nextToken, resultsPerPage, totalResults, getWithToken, }: PaginationOptions); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +{ data, logger, prevToken, nextToken, resultsPerPage, totalResults, getWithToken, } + + + + +[PaginationOptions](./youtubes.js.paginationoptions.md)<T> + + + + + +
diff --git a/docs/api/youtubes.js.pagination.all.md b/docs/api/youtubes.js.pagination.all.md new file mode 100644 index 0000000..a694a42 --- /dev/null +++ b/docs/api/youtubes.js.pagination.all.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [all](./youtubes.js.pagination.all.md) + +## Pagination.all() method + +Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quotas, so be careful when using it in actual applications. - We strongly recommend fetching the next page based on user actions (e.g., scrolling). + +**Signature:** + +```typescript +all(): Promise; +``` +**Returns:** + +Promise<T\[\]> + +All pages data in an array. If several items are in a page, this method will return a 2D array. Use `flat()` to convert it to a 1D array. + +## Example + + +```ts +import { ApiClient, StaticOAuthProvider } from "youtubes.js"; + +const oauth = new StaticOAuthProvider({ + accessToken: "ACCESS_TOKEN", +}); +const client = new ApiClient({ oauth }); + +const playlists = await client.playlists.getMine(); +const allPlaylists = (await playlists.all()).flat(); +``` + diff --git a/docs/api/youtubes.js.pagination.data.md b/docs/api/youtubes.js.pagination.data.md new file mode 100644 index 0000000..dc5b914 --- /dev/null +++ b/docs/api/youtubes.js.pagination.data.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [data](./youtubes.js.pagination.data.md) + +## Pagination.data property + +The data of the current page. + +**Signature:** + +```typescript +data: T; +``` diff --git a/docs/api/youtubes.js.pagination.md b/docs/api/youtubes.js.pagination.md new file mode 100644 index 0000000..fdb608b --- /dev/null +++ b/docs/api/youtubes.js.pagination.md @@ -0,0 +1,191 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) + +## Pagination class + +Provides utility methods for pagination. + +**Signature:** + +```typescript +export declare class Pagination +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)({ data, logger, prevToken, nextToken, resultsPerPage, totalResults, getWithToken, })](./youtubes.js.pagination._constructor_.md) + + + + + + + +Constructs a new instance of the `Pagination` class + + +
+ +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./youtubes.js.pagination.data.md) + + + + + + + +T + + + + +The data of the current page. + + +
+ +[resultsPerPage](./youtubes.js.pagination.resultsperpage.md) + + + + + + + +number + + + + +The number of results included in the API response. + + +
+ +[totalResults](./youtubes.js.pagination.totalresults.md) + + + + + + + +number + + + + +The total number of results in the result set. \*\*NOTE\*\*: This number may be larger than the number of actual retrievable results. The YouTube Data API may not return some playlists (for example, the "Liked videos" playlist). However, the totalResults count may include them. + + +
+ +## Methods + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[all()](./youtubes.js.pagination.all.md) + + + + + + + +Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quotas, so be careful when using it in actual applications. - We strongly recommend fetching the next page based on user actions (e.g., scrolling). + + +
+ +[next()](./youtubes.js.pagination.next.md) + + + + + + + +Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the \[YouTube Data API reference\](https://developers.google.com/youtube/v3/determine\_quota\_cost) + + +
+ +[prev()](./youtubes.js.pagination.prev.md) + + + + + + + +Fetches the previous page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the \[YouTube Data API reference\](https://developers.google.com/youtube/v3/determine\_quota\_cost) + + +
diff --git a/docs/api/youtubes.js.pagination.next.md b/docs/api/youtubes.js.pagination.next.md new file mode 100644 index 0000000..f3f61d8 --- /dev/null +++ b/docs/api/youtubes.js.pagination.next.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [next](./youtubes.js.pagination.next.md) + +## Pagination.next() method + +Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the \[YouTube Data API reference\](https://developers.google.com/youtube/v3/determine\_quota\_cost) + +**Signature:** + +```typescript +next(): Promise | null>; +``` +**Returns:** + +Promise<[Pagination](./youtubes.js.pagination.md)<T> \| null> + +The next page. If there is no next page, returns `null`. + +## Example + + +```ts +import { ApiClient, StaticOAuthProvider } from "youtubes.js"; + +const oauth = new StaticOAuthProvider({ + accessToken: "ACCESS_TOKEN", +}); +const client = new ApiClient({ oauth }); + +const playlists = await client.playlists.getMine(); +console.log(playlists.data); // The first page of playlists +const nextPage = await playlists.next(); +console.log(nextPage?.data); // The second page of playlists or null if there is no next page +``` + diff --git a/docs/api/youtubes.js.pagination.prev.md b/docs/api/youtubes.js.pagination.prev.md new file mode 100644 index 0000000..bd22b82 --- /dev/null +++ b/docs/api/youtubes.js.pagination.prev.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [prev](./youtubes.js.pagination.prev.md) + +## Pagination.prev() method + +Fetches the previous page. - \*\*NOTE\*\*: This method will use the same quotas as the original request. - Normally, GET requests use a quota of 1 unit, while other methods use 50 units. - However, some heavy methods use more than 50 units. - See more details on the \[YouTube Data API reference\](https://developers.google.com/youtube/v3/determine\_quota\_cost) + +**Signature:** + +```typescript +prev(): Promise | null>; +``` +**Returns:** + +Promise<[Pagination](./youtubes.js.pagination.md)<T> \| null> + +The previous page. If there is no previous page, returns `null`. + +## Example + + +```ts +import { ApiClient, StaticOAuthProvider } from "youtubes.js"; + +const oauth = new StaticOAuthProvider({ + accessToken: "ACCESS_TOKEN", +}); +const client = new ApiClient({ oauth }); + +const playlists = await client.playlists.getMine(); +console.log(playlists.data); // The first page of playlists +const prevPage = await playlists.prev(); +console.log(prevPage?.data); // The previous page of playlists or null if there is no previous page +``` + diff --git a/docs/api/youtubes.js.pagination.resultsperpage.md b/docs/api/youtubes.js.pagination.resultsperpage.md new file mode 100644 index 0000000..5828283 --- /dev/null +++ b/docs/api/youtubes.js.pagination.resultsperpage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [resultsPerPage](./youtubes.js.pagination.resultsperpage.md) + +## Pagination.resultsPerPage property + +The number of results included in the API response. + +**Signature:** + +```typescript +resultsPerPage: number; +``` diff --git a/docs/api/youtubes.js.pagination.totalresults.md b/docs/api/youtubes.js.pagination.totalresults.md new file mode 100644 index 0000000..4442021 --- /dev/null +++ b/docs/api/youtubes.js.pagination.totalresults.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Pagination](./youtubes.js.pagination.md) > [totalResults](./youtubes.js.pagination.totalresults.md) + +## Pagination.totalResults property + +The total number of results in the result set. \*\*NOTE\*\*: This number may be larger than the number of actual retrievable results. The YouTube Data API may not return some playlists (for example, the "Liked videos" playlist). However, the totalResults count may include them. + +**Signature:** + +```typescript +totalResults: number; +``` diff --git a/docs/api/youtubes.js.paginationoptions.data.md b/docs/api/youtubes.js.paginationoptions.data.md new file mode 100644 index 0000000..545d5ac --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [data](./youtubes.js.paginationoptions.data.md) + +## PaginationOptions.data property + +**Signature:** + +```typescript +data: T; +``` diff --git a/docs/api/youtubes.js.paginationoptions.getwithtoken.md b/docs/api/youtubes.js.paginationoptions.getwithtoken.md new file mode 100644 index 0000000..af87f81 --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.getwithtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [getWithToken](./youtubes.js.paginationoptions.getwithtoken.md) + +## PaginationOptions.getWithToken property + +**Signature:** + +```typescript +getWithToken: (token: string) => Promise>; +``` diff --git a/docs/api/youtubes.js.paginationoptions.logger.md b/docs/api/youtubes.js.paginationoptions.logger.md new file mode 100644 index 0000000..67a85ae --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.logger.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [logger](./youtubes.js.paginationoptions.logger.md) + +## PaginationOptions.logger property + +**Signature:** + +```typescript +logger: Logger; +``` diff --git a/docs/api/youtubes.js.paginationoptions.md b/docs/api/youtubes.js.paginationoptions.md new file mode 100644 index 0000000..a987f39 --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.md @@ -0,0 +1,163 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) + +## PaginationOptions interface + +**Signature:** + +```typescript +export interface PaginationOptions +``` + +## Properties + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[data](./youtubes.js.paginationoptions.data.md) + + + + + + + +T + + + + + +
+ +[getWithToken](./youtubes.js.paginationoptions.getwithtoken.md) + + + + + + + +(token: string) => Promise<[Pagination](./youtubes.js.pagination.md)<T>> + + + + + +
+ +[logger](./youtubes.js.paginationoptions.logger.md) + + + + + + + +Logger + + + + + +
+ +[nextToken?](./youtubes.js.paginationoptions.nexttoken.md) + + + + + + + +string \| null + + + + +_(Optional)_ + + +
+ +[prevToken?](./youtubes.js.paginationoptions.prevtoken.md) + + + + + + + +string \| null + + + + +_(Optional)_ + + +
+ +[resultsPerPage?](./youtubes.js.paginationoptions.resultsperpage.md) + + + + + + + +number \| null + + + + +_(Optional)_ + + +
+ +[totalResults?](./youtubes.js.paginationoptions.totalresults.md) + + + + + + + +number \| null + + + + +_(Optional)_ + + +
diff --git a/docs/api/youtubes.js.paginationoptions.nexttoken.md b/docs/api/youtubes.js.paginationoptions.nexttoken.md new file mode 100644 index 0000000..6f61f53 --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.nexttoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [nextToken](./youtubes.js.paginationoptions.nexttoken.md) + +## PaginationOptions.nextToken property + +**Signature:** + +```typescript +nextToken?: string | null; +``` diff --git a/docs/api/youtubes.js.paginationoptions.prevtoken.md b/docs/api/youtubes.js.paginationoptions.prevtoken.md new file mode 100644 index 0000000..2e37146 --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.prevtoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [prevToken](./youtubes.js.paginationoptions.prevtoken.md) + +## PaginationOptions.prevToken property + +**Signature:** + +```typescript +prevToken?: string | null; +``` diff --git a/docs/api/youtubes.js.paginationoptions.resultsperpage.md b/docs/api/youtubes.js.paginationoptions.resultsperpage.md new file mode 100644 index 0000000..9984223 --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.resultsperpage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [resultsPerPage](./youtubes.js.paginationoptions.resultsperpage.md) + +## PaginationOptions.resultsPerPage property + +**Signature:** + +```typescript +resultsPerPage?: number | null; +``` diff --git a/docs/api/youtubes.js.paginationoptions.totalresults.md b/docs/api/youtubes.js.paginationoptions.totalresults.md new file mode 100644 index 0000000..57fbcb5 --- /dev/null +++ b/docs/api/youtubes.js.paginationoptions.totalresults.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PaginationOptions](./youtubes.js.paginationoptions.md) > [totalResults](./youtubes.js.paginationoptions.totalresults.md) + +## PaginationOptions.totalResults property + +**Signature:** + +```typescript +totalResults?: number | null; +``` diff --git a/docs/api/youtubes.js.playlist._constructor_.md b/docs/api/youtubes.js.playlist._constructor_.md new file mode 100644 index 0000000..4a402b9 --- /dev/null +++ b/docs/api/youtubes.js.playlist._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [(constructor)](./youtubes.js.playlist._constructor_.md) + +## Playlist.(constructor) + +Constructs a new instance of the `Playlist` class + +**Signature:** + +```typescript +constructor({ id, title, description, thumbnails, privacy, count, publishedAt, channelId, channelName, }: PlaylistData); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +{ id, title, description, thumbnails, privacy, count, publishedAt, channelId, channelName, } + + + + +PlaylistData + + + + + +
diff --git a/docs/api/youtubes.js.playlist.channelid.md b/docs/api/youtubes.js.playlist.channelid.md new file mode 100644 index 0000000..5c0be09 --- /dev/null +++ b/docs/api/youtubes.js.playlist.channelid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [channelId](./youtubes.js.playlist.channelid.md) + +## Playlist.channelId property + +The channel id that the playlist belongs to. + +**Signature:** + +```typescript +channelId: string; +``` diff --git a/docs/api/youtubes.js.playlist.channelname.md b/docs/api/youtubes.js.playlist.channelname.md new file mode 100644 index 0000000..9d78359 --- /dev/null +++ b/docs/api/youtubes.js.playlist.channelname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [channelName](./youtubes.js.playlist.channelname.md) + +## Playlist.channelName property + +The channel name that the playlist belongs to. + +**Signature:** + +```typescript +channelName: string; +``` diff --git a/docs/api/youtubes.js.playlist.count.md b/docs/api/youtubes.js.playlist.count.md new file mode 100644 index 0000000..8b7d8fa --- /dev/null +++ b/docs/api/youtubes.js.playlist.count.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [count](./youtubes.js.playlist.count.md) + +## Playlist.count property + +The number of videos in the playlist. + +**Signature:** + +```typescript +count: number; +``` diff --git a/docs/api/youtubes.js.playlist.description.md b/docs/api/youtubes.js.playlist.description.md new file mode 100644 index 0000000..5f88bec --- /dev/null +++ b/docs/api/youtubes.js.playlist.description.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [description](./youtubes.js.playlist.description.md) + +## Playlist.description property + +The description of the playlist. + +**Signature:** + +```typescript +description: string; +``` diff --git a/docs/api/youtubes.js.playlist.from.md b/docs/api/youtubes.js.playlist.from.md new file mode 100644 index 0000000..22746ab --- /dev/null +++ b/docs/api/youtubes.js.playlist.from.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [from](./youtubes.js.playlist.from.md) + +## Playlist.from() method + +**Signature:** + +```typescript +static from(data: youtube_v3.Schema$Playlist, logger: Logger): Result; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +data + + + + +youtube\_v3.Schema$Playlist + + + + + +
+ +logger + + + + +Logger + + + + + +
+**Returns:** + +Result<[Playlist](./youtubes.js.playlist.md), string> + diff --git a/docs/api/youtubes.js.playlist.id.md b/docs/api/youtubes.js.playlist.id.md new file mode 100644 index 0000000..fe681cf --- /dev/null +++ b/docs/api/youtubes.js.playlist.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [id](./youtubes.js.playlist.id.md) + +## Playlist.id property + +The ID that YouTube uses to uniquely identify the playlist. + +**Signature:** + +```typescript +id: string; +``` diff --git a/docs/api/youtubes.js.playlist.md b/docs/api/youtubes.js.playlist.md new file mode 100644 index 0000000..b5c7b1b --- /dev/null +++ b/docs/api/youtubes.js.playlist.md @@ -0,0 +1,279 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) + +## Playlist class + +Represents a YouTube playlist resource. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists\#resource) + +**Signature:** + +```typescript +export declare class Playlist +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)({ id, title, description, thumbnails, privacy, count, publishedAt, channelId, channelName, })](./youtubes.js.playlist._constructor_.md) + + + + + + + +Constructs a new instance of the `Playlist` class + + +
+ +## Properties + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[channelId](./youtubes.js.playlist.channelid.md) + + + + + + + +string + + + + +The channel id that the playlist belongs to. + + +
+ +[channelName](./youtubes.js.playlist.channelname.md) + + + + + + + +string + + + + +The channel name that the playlist belongs to. + + +
+ +[count](./youtubes.js.playlist.count.md) + + + + + + + +number + + + + +The number of videos in the playlist. + + +
+ +[description](./youtubes.js.playlist.description.md) + + + + + + + +string + + + + +The description of the playlist. + + +
+ +[id](./youtubes.js.playlist.id.md) + + + + + + + +string + + + + +The ID that YouTube uses to uniquely identify the playlist. + + +
+ +[privacy](./youtubes.js.playlist.privacy.md) + + + + + + + +[Privacy](./youtubes.js.privacy.md) + + + + +The privacy status of the playlist. + + +
+ +[publishedAt](./youtubes.js.playlist.publishedat.md) + + + + + + + +Date + + + + +The date and time that the playlist was created. + + +
+ +[thumbnails](./youtubes.js.playlist.thumbnails.md) + + + + + + + +[Thumbnails](./youtubes.js.thumbnails.md) + + + + +The thumbnails of the playlist. + + +
+ +[title](./youtubes.js.playlist.title.md) + + + + + + + +string + + + + +The title of the playlist. + + +
+ +## Methods + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[from(data, logger)](./youtubes.js.playlist.from.md) + + + + +`static` + + + + + +
diff --git a/docs/api/youtubes.js.playlist.privacy.md b/docs/api/youtubes.js.playlist.privacy.md new file mode 100644 index 0000000..3a57e3c --- /dev/null +++ b/docs/api/youtubes.js.playlist.privacy.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [privacy](./youtubes.js.playlist.privacy.md) + +## Playlist.privacy property + +The privacy status of the playlist. + +**Signature:** + +```typescript +privacy: Privacy; +``` diff --git a/docs/api/youtubes.js.playlist.publishedat.md b/docs/api/youtubes.js.playlist.publishedat.md new file mode 100644 index 0000000..fd18df1 --- /dev/null +++ b/docs/api/youtubes.js.playlist.publishedat.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [publishedAt](./youtubes.js.playlist.publishedat.md) + +## Playlist.publishedAt property + +The date and time that the playlist was created. + +**Signature:** + +```typescript +publishedAt: Date; +``` diff --git a/docs/api/youtubes.js.playlist.thumbnails.md b/docs/api/youtubes.js.playlist.thumbnails.md new file mode 100644 index 0000000..3018300 --- /dev/null +++ b/docs/api/youtubes.js.playlist.thumbnails.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [thumbnails](./youtubes.js.playlist.thumbnails.md) + +## Playlist.thumbnails property + +The thumbnails of the playlist. + +**Signature:** + +```typescript +thumbnails: Thumbnails; +``` diff --git a/docs/api/youtubes.js.playlist.title.md b/docs/api/youtubes.js.playlist.title.md new file mode 100644 index 0000000..d8994a5 --- /dev/null +++ b/docs/api/youtubes.js.playlist.title.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Playlist](./youtubes.js.playlist.md) > [title](./youtubes.js.playlist.title.md) + +## Playlist.title property + +The title of the playlist. + +**Signature:** + +```typescript +title: string; +``` diff --git a/docs/api/youtubes.js.playlistmanager._constructor_.md b/docs/api/youtubes.js.playlistmanager._constructor_.md new file mode 100644 index 0000000..0a1d116 --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) > [(constructor)](./youtubes.js.playlistmanager._constructor_.md) + +## PlaylistManager.(constructor) + +Constructs a new instance of the `PlaylistManager` class + +**Signature:** + +```typescript +constructor({ oauth, logger }: PlaylistManagerOptions); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +{ oauth, logger } + + + + +PlaylistManagerOptions + + + + + +
diff --git a/docs/api/youtubes.js.playlistmanager.create.md b/docs/api/youtubes.js.playlistmanager.create.md new file mode 100644 index 0000000..a0f54af --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager.create.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) > [create](./youtubes.js.playlistmanager.create.md) + +## PlaylistManager.create() method + +Creates a playlist. - This operation uses 50 quota units. - There is a limit of approximately 10 playlists per day for creation. - For more details, see the issue: https://issuetracker.google.com/issues/255216949 + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/insert) + +**Signature:** + +```typescript +create(options: CreatePlaylistOptions): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +options + + + + +[CreatePlaylistOptions](./youtubes.js.createplaylistoptions.md) + + + + +Options for creating a playlist. + + +
+**Returns:** + +Promise<[Playlist](./youtubes.js.playlist.md)> + diff --git a/docs/api/youtubes.js.playlistmanager.deletebyid.md b/docs/api/youtubes.js.playlistmanager.deletebyid.md new file mode 100644 index 0000000..27eecf6 --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager.deletebyid.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) > [deleteById](./youtubes.js.playlistmanager.deletebyid.md) + +## PlaylistManager.deleteById() method + +Deletes a playlist by its ID. - This operation uses 50 quota units. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/delete) + +**Signature:** + +```typescript +deleteById(playlistId: string): Promise; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +playlistId + + + + +string + + + + +The ID of the playlist. + + +
+**Returns:** + +Promise<void> + diff --git a/docs/api/youtubes.js.playlistmanager.getbychannelid.md b/docs/api/youtubes.js.playlistmanager.getbychannelid.md new file mode 100644 index 0000000..1933358 --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager.getbychannelid.md @@ -0,0 +1,86 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) > [getByChannelId](./youtubes.js.playlistmanager.getbychannelid.md) + +## PlaylistManager.getByChannelId() method + +Fetches the playlists of a channel by its ID. - This operation uses 1 quota unit. - Retrieves all playlists when given an authenticated user's channel ID. Otherwise, only public playlists are accessible. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/list) + +**Signature:** + +```typescript +getByChannelId(id: string, pageToken?: string): Promise>; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +id + + + + +string + + + + +The ID of the channel. + + +
+ +pageToken + + + + +string + + + + +_(Optional)_ The token for pagination. + + +
+**Returns:** + +Promise<[Pagination](./youtubes.js.pagination.md)<[Playlist](./youtubes.js.playlist.md)\[\]>> + +## Example + + +```ts +import { ApiClient, StaticOAuthProvider } from "youtubes.js"; + +const oauth = new StaticOAuthProvider({ + accessToken: "ACCESS_TOKEN", +}); +const client = new ApiClient({ oauth }); + +const playlists = await client.playlists.getByChannelId("CHANNEL_ID"); +console.log(playlists.data); // Playlist[] +``` + diff --git a/docs/api/youtubes.js.playlistmanager.getbyids.md b/docs/api/youtubes.js.playlistmanager.getbyids.md new file mode 100644 index 0000000..a58b998 --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager.getbyids.md @@ -0,0 +1,86 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) > [getByIds](./youtubes.js.playlistmanager.getbyids.md) + +## PlaylistManager.getByIds() method + +Fetches a playlist by its ID. - This operation uses 1 quota unit. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/list) + +**Signature:** + +```typescript +getByIds(ids: string[], pageToken?: string): Promise>; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +ids + + + + +string\[\] + + + + +The IDs of the playlist. + + +
+ +pageToken + + + + +string + + + + +_(Optional)_ The token for pagination. + + +
+**Returns:** + +Promise<[Pagination](./youtubes.js.pagination.md)<[Playlist](./youtubes.js.playlist.md)\[\]>> + +## Example + + +```ts +import { ApiClient, StaticOAuthProvider } from "youtubes.js"; + +const oauth = new StaticOAuthProvider({ + accessToken: "ACCESS_TOKEN", +}); +const client = new ApiClient({ oauth }); + +const playlists = await client.playlists.getByIds(["ID1", "ID2"]); +console.log(playlists.data); // [Playlist, Playlist] +``` + diff --git a/docs/api/youtubes.js.playlistmanager.getmine.md b/docs/api/youtubes.js.playlistmanager.getmine.md new file mode 100644 index 0000000..f58e1dd --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager.getmine.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) > [getMine](./youtubes.js.playlistmanager.getmine.md) + +## PlaylistManager.getMine() method + +Fetches the playlists owned by the authenticated user. - This operation uses 1 quota unit. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/list) + +**Signature:** + +```typescript +getMine(pageToken?: string): Promise>; +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +pageToken + + + + +string + + + + +_(Optional)_ The token for pagination. + + +
+**Returns:** + +Promise<[Pagination](./youtubes.js.pagination.md)<[Playlist](./youtubes.js.playlist.md)\[\]>> + +## Example + + +```ts +import { ApiClient, StaticOAuthProvider } from "youtubes.js"; + +const oauth = new StaticOAuthProvider({ + accessToken: "ACCESS_TOKEN", +}); + +const client = new ApiClient({ oauth }); +const playlists = await client.playlists.getMine(); +console.log(playlists.data); // Playlist[] +``` + diff --git a/docs/api/youtubes.js.playlistmanager.md b/docs/api/youtubes.js.playlistmanager.md new file mode 100644 index 0000000..f53c18a --- /dev/null +++ b/docs/api/youtubes.js.playlistmanager.md @@ -0,0 +1,149 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistManager](./youtubes.js.playlistmanager.md) + +## PlaylistManager class + +Manager for playlist endpoints. Provides methods for `/youtube/v3/playlists`. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists) + +**Signature:** + +```typescript +export declare class PlaylistManager +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)({ oauth, logger })](./youtubes.js.playlistmanager._constructor_.md) + + + + + + + +Constructs a new instance of the `PlaylistManager` class + + +
+ +## Methods + + + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[create(options)](./youtubes.js.playlistmanager.create.md) + + + + + + + +Creates a playlist. - This operation uses 50 quota units. - There is a limit of approximately 10 playlists per day for creation. - For more details, see the issue: https://issuetracker.google.com/issues/255216949 + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/insert) + + +
+ +[deleteById(playlistId)](./youtubes.js.playlistmanager.deletebyid.md) + + + + + + + +Deletes a playlist by its ID. - This operation uses 50 quota units. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/delete) + + +
+ +[getByChannelId(id, pageToken)](./youtubes.js.playlistmanager.getbychannelid.md) + + + + + + + +Fetches the playlists of a channel by its ID. - This operation uses 1 quota unit. - Retrieves all playlists when given an authenticated user's channel ID. Otherwise, only public playlists are accessible. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/list) + + +
+ +[getByIds(ids, pageToken)](./youtubes.js.playlistmanager.getbyids.md) + + + + + + + +Fetches a playlist by its ID. - This operation uses 1 quota unit. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/list) + + +
+ +[getMine(pageToken)](./youtubes.js.playlistmanager.getmine.md) + + + + + + + +Fetches the playlists owned by the authenticated user. - This operation uses 1 quota unit. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists/list) + + +
diff --git a/docs/api/youtubes.js.privacy.md b/docs/api/youtubes.js.privacy.md new file mode 100644 index 0000000..200bea3 --- /dev/null +++ b/docs/api/youtubes.js.privacy.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Privacy](./youtubes.js.privacy.md) + +## Privacy type + +**Signature:** + +```typescript +export type Privacy = "public" | "unlisted" | "private"; +``` diff --git a/docs/api/youtubes.js.staticcredentials.accesstoken.md b/docs/api/youtubes.js.staticcredentials.accesstoken.md new file mode 100644 index 0000000..54d7d99 --- /dev/null +++ b/docs/api/youtubes.js.staticcredentials.accesstoken.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [StaticCredentials](./youtubes.js.staticcredentials.md) > [accessToken](./youtubes.js.staticcredentials.accesstoken.md) + +## StaticCredentials.accessToken property + +**Signature:** + +```typescript +accessToken: string; +``` diff --git a/docs/api/youtubes.js.staticcredentials.md b/docs/api/youtubes.js.staticcredentials.md new file mode 100644 index 0000000..0d3790e --- /dev/null +++ b/docs/api/youtubes.js.staticcredentials.md @@ -0,0 +1,55 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [StaticCredentials](./youtubes.js.staticcredentials.md) + +## StaticCredentials interface + +The credentials for a `StaticOAuthProvider` + +**Signature:** + +```typescript +export interface StaticCredentials +``` + +## Properties + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[accessToken](./youtubes.js.staticcredentials.accesstoken.md) + + + + + + + +string + + + + + +
diff --git a/docs/api/youtubes.js.staticoauthprovider._constructor_.md b/docs/api/youtubes.js.staticoauthprovider._constructor_.md new file mode 100644 index 0000000..28ebca3 --- /dev/null +++ b/docs/api/youtubes.js.staticoauthprovider._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [StaticOAuthProvider](./youtubes.js.staticoauthprovider.md) > [(constructor)](./youtubes.js.staticoauthprovider._constructor_.md) + +## StaticOAuthProvider.(constructor) + +Constructs a new instance of the `StaticOAuthProvider` class + +**Signature:** + +```typescript +constructor(credentials: StaticCredentials); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +credentials + + + + +[StaticCredentials](./youtubes.js.staticcredentials.md) + + + + + +
diff --git a/docs/api/youtubes.js.staticoauthprovider.getnativeoauth.md b/docs/api/youtubes.js.staticoauthprovider.getnativeoauth.md new file mode 100644 index 0000000..fff9c26 --- /dev/null +++ b/docs/api/youtubes.js.staticoauthprovider.getnativeoauth.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [StaticOAuthProvider](./youtubes.js.staticoauthprovider.md) > [getNativeOauth](./youtubes.js.staticoauthprovider.getnativeoauth.md) + +## StaticOAuthProvider.getNativeOauth() method + +**Signature:** + +```typescript +getNativeOauth(): OAuth2Client; +``` +**Returns:** + +OAuth2Client + diff --git a/docs/api/youtubes.js.staticoauthprovider.md b/docs/api/youtubes.js.staticoauthprovider.md new file mode 100644 index 0000000..9954565 --- /dev/null +++ b/docs/api/youtubes.js.staticoauthprovider.md @@ -0,0 +1,80 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [StaticOAuthProvider](./youtubes.js.staticoauthprovider.md) + +## StaticOAuthProvider class + +An OAuth provider that doesn't refresh the token + +**Signature:** + +```typescript +export declare class StaticOAuthProvider extends BaseOAuthProvider +``` +**Extends:** BaseOAuthProvider + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(credentials)](./youtubes.js.staticoauthprovider._constructor_.md) + + + + + + + +Constructs a new instance of the `StaticOAuthProvider` class + + +
+ +## Methods + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[getNativeOauth()](./youtubes.js.staticoauthprovider.getnativeoauth.md) + + + + + + + + +
diff --git a/docs/api/youtubes.js.thumbnail.height.md b/docs/api/youtubes.js.thumbnail.height.md new file mode 100644 index 0000000..cee990c --- /dev/null +++ b/docs/api/youtubes.js.thumbnail.height.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnail](./youtubes.js.thumbnail.md) > [height](./youtubes.js.thumbnail.height.md) + +## Thumbnail.height property + +The height of the thumbnail image. + +**Signature:** + +```typescript +height: number; +``` diff --git a/docs/api/youtubes.js.thumbnail.md b/docs/api/youtubes.js.thumbnail.md new file mode 100644 index 0000000..a4d3820 --- /dev/null +++ b/docs/api/youtubes.js.thumbnail.md @@ -0,0 +1,93 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnail](./youtubes.js.thumbnail.md) + +## Thumbnail interface + +**Signature:** + +```typescript +export interface Thumbnail +``` + +## Properties + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[height](./youtubes.js.thumbnail.height.md) + + + + + + + +number + + + + +The height of the thumbnail image. + + +
+ +[url](./youtubes.js.thumbnail.url.md) + + + + + + + +string + + + + +The URL of the thumbnail image. + + +
+ +[width](./youtubes.js.thumbnail.width.md) + + + + + + + +number + + + + +The width of the thumbnail image. + + +
diff --git a/docs/api/youtubes.js.thumbnail.url.md b/docs/api/youtubes.js.thumbnail.url.md new file mode 100644 index 0000000..9b91a4e --- /dev/null +++ b/docs/api/youtubes.js.thumbnail.url.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnail](./youtubes.js.thumbnail.md) > [url](./youtubes.js.thumbnail.url.md) + +## Thumbnail.url property + +The URL of the thumbnail image. + +**Signature:** + +```typescript +url: string; +``` diff --git a/docs/api/youtubes.js.thumbnail.width.md b/docs/api/youtubes.js.thumbnail.width.md new file mode 100644 index 0000000..d225e4a --- /dev/null +++ b/docs/api/youtubes.js.thumbnail.width.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnail](./youtubes.js.thumbnail.md) > [width](./youtubes.js.thumbnail.width.md) + +## Thumbnail.width property + +The width of the thumbnail image. + +**Signature:** + +```typescript +width: number; +``` diff --git a/docs/api/youtubes.js.thumbnails._constructor_.md b/docs/api/youtubes.js.thumbnails._constructor_.md new file mode 100644 index 0000000..388e40b --- /dev/null +++ b/docs/api/youtubes.js.thumbnails._constructor_.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [(constructor)](./youtubes.js.thumbnails._constructor_.md) + +## Thumbnails.(constructor) + +Constructs a new instance of the `Thumbnails` class + +**Signature:** + +```typescript +constructor(data: ThumbnailsData); +``` + +## Parameters + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +data + + + + +ThumbnailsData + + + + + +
diff --git a/docs/api/youtubes.js.thumbnails.default.md b/docs/api/youtubes.js.thumbnails.default.md new file mode 100644 index 0000000..e03b9c1 --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.default.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [default](./youtubes.js.thumbnails.default.md) + +## Thumbnails.default property + +**Signature:** + +```typescript +default?: Thumbnail; +``` diff --git a/docs/api/youtubes.js.thumbnails.from.md b/docs/api/youtubes.js.thumbnails.from.md new file mode 100644 index 0000000..47ec253 --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.from.md @@ -0,0 +1,67 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [from](./youtubes.js.thumbnails.from.md) + +## Thumbnails.from() method + +Generates a `Thumbnails` instance from the YouTube API raw data. + +**Signature:** + +```typescript +static from(data: youtube_v3.Schema$ThumbnailDetails, logger: Logger): Result; +``` + +## Parameters + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +data + + + + +youtube\_v3.Schema$ThumbnailDetails + + + + +The raw data from the YouTube API. + + +
+ +logger + + + + +Logger + + + + + +
+**Returns:** + +Result<[Thumbnails](./youtubes.js.thumbnails.md), string> + diff --git a/docs/api/youtubes.js.thumbnails.gethighestresolution.md b/docs/api/youtubes.js.thumbnails.gethighestresolution.md new file mode 100644 index 0000000..1302ad7 --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.gethighestresolution.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [getHighestResolution](./youtubes.js.thumbnails.gethighestresolution.md) + +## Thumbnails.getHighestResolution() method + +Returns the highest resolution thumbnail. + +**Signature:** + +```typescript +getHighestResolution(): Thumbnail | null; +``` +**Returns:** + +[Thumbnail](./youtubes.js.thumbnail.md) \| null + +The highest resolution thumbnail of the thumbnails. + diff --git a/docs/api/youtubes.js.thumbnails.getlowestresolution.md b/docs/api/youtubes.js.thumbnails.getlowestresolution.md new file mode 100644 index 0000000..cdff5a9 --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.getlowestresolution.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [getLowestResolution](./youtubes.js.thumbnails.getlowestresolution.md) + +## Thumbnails.getLowestResolution() method + +Returns the lowest resolution thumbnail. + +**Signature:** + +```typescript +getLowestResolution(): Thumbnail | null; +``` +**Returns:** + +[Thumbnail](./youtubes.js.thumbnail.md) \| null + +The lowest resolution thumbnail of the thumbnails. + diff --git a/docs/api/youtubes.js.thumbnails.high.md b/docs/api/youtubes.js.thumbnails.high.md new file mode 100644 index 0000000..46a2e6c --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.high.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [high](./youtubes.js.thumbnails.high.md) + +## Thumbnails.high property + +**Signature:** + +```typescript +high?: Thumbnail; +``` diff --git a/docs/api/youtubes.js.thumbnails.maxres.md b/docs/api/youtubes.js.thumbnails.maxres.md new file mode 100644 index 0000000..f9e4d4f --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.maxres.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [maxres](./youtubes.js.thumbnails.maxres.md) + +## Thumbnails.maxres property + +**Signature:** + +```typescript +maxres?: Thumbnail; +``` diff --git a/docs/api/youtubes.js.thumbnails.md b/docs/api/youtubes.js.thumbnails.md new file mode 100644 index 0000000..82e2d77 --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.md @@ -0,0 +1,233 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) + +## Thumbnails class + +Presents the thumbnails of the video or the playlist. + +\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/thumbnails) + +**Signature:** + +```typescript +export declare class Thumbnails +``` + +## Constructors + + + +
+ +Constructor + + + + +Modifiers + + + + +Description + + +
+ +[(constructor)(data)](./youtubes.js.thumbnails._constructor_.md) + + + + + + + +Constructs a new instance of the `Thumbnails` class + + +
+ +## Properties + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[default?](./youtubes.js.thumbnails.default.md) + + + + + + + +[Thumbnail](./youtubes.js.thumbnail.md) + + + + +_(Optional)_ + + +
+ +[high?](./youtubes.js.thumbnails.high.md) + + + + + + + +[Thumbnail](./youtubes.js.thumbnail.md) + + + + +_(Optional)_ + + +
+ +[maxres?](./youtubes.js.thumbnails.maxres.md) + + + + + + + +[Thumbnail](./youtubes.js.thumbnail.md) + + + + +_(Optional)_ + + +
+ +[medium?](./youtubes.js.thumbnails.medium.md) + + + + + + + +[Thumbnail](./youtubes.js.thumbnail.md) + + + + +_(Optional)_ + + +
+ +[standard?](./youtubes.js.thumbnails.standard.md) + + + + + + + +[Thumbnail](./youtubes.js.thumbnail.md) + + + + +_(Optional)_ + + +
+ +## Methods + + + + + +
+ +Method + + + + +Modifiers + + + + +Description + + +
+ +[from(data, logger)](./youtubes.js.thumbnails.from.md) + + + + +`static` + + + + +Generates a `Thumbnails` instance from the YouTube API raw data. + + +
+ +[getHighestResolution()](./youtubes.js.thumbnails.gethighestresolution.md) + + + + + + + +Returns the highest resolution thumbnail. + + +
+ +[getLowestResolution()](./youtubes.js.thumbnails.getlowestresolution.md) + + + + + + + +Returns the lowest resolution thumbnail. + + +
diff --git a/docs/api/youtubes.js.thumbnails.medium.md b/docs/api/youtubes.js.thumbnails.medium.md new file mode 100644 index 0000000..94e3ff1 --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.medium.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [medium](./youtubes.js.thumbnails.medium.md) + +## Thumbnails.medium property + +**Signature:** + +```typescript +medium?: Thumbnail; +``` diff --git a/docs/api/youtubes.js.thumbnails.standard.md b/docs/api/youtubes.js.thumbnails.standard.md new file mode 100644 index 0000000..be8f10e --- /dev/null +++ b/docs/api/youtubes.js.thumbnails.standard.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [Thumbnails](./youtubes.js.thumbnails.md) > [standard](./youtubes.js.thumbnails.standard.md) + +## Thumbnails.standard property + +**Signature:** + +```typescript +standard?: Thumbnail; +``` diff --git a/package-lock.json b/package-lock.json index 15f4d8f..e8928b2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "youtubes.js", - "version": "0.1.2", + "version": "0.2.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "youtubes.js", - "version": "0.1.2", + "version": "0.2.0", "license": "MIT", "dependencies": { "googleapis": "^144.0.0", diff --git a/package.json b/package.json index 37c171d..9fc7ad2 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "youtubes.js", "description": "A JavaScript client for YouTube Data API v3.", - "version": "0.1.2", + "version": "0.2.0", "main": "dist/index.js", "types": "dist/index.d.ts", "keywords": [