-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
# [0.2.0](v0.1.2...v0.2.0) (2025-01-18) ### Features * **ci:** Add API documentation generation to release workflow ([85dd586](85dd586))
- Loading branch information
1 parent
e133553
commit be6758f
Showing
74 changed files
with
3,177 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) | ||
|
||
## API Reference | ||
|
||
## Packages | ||
|
||
<table><thead><tr><th> | ||
|
||
Package | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
[youtubes.js](./youtubes.js.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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 | ||
|
||
<table><thead><tr><th> | ||
|
||
Parameter | ||
|
||
|
||
</th><th> | ||
|
||
Type | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
{ oauth, logLevel } | ||
|
||
|
||
</td><td> | ||
|
||
[ApiClientOptions](./youtubes.js.apiclientoptions.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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 | ||
|
||
<table><thead><tr><th> | ||
|
||
Constructor | ||
|
||
|
||
</th><th> | ||
|
||
Modifiers | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
[(constructor)({ oauth, logLevel })](./youtubes.js.apiclient._constructor_.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td><td> | ||
|
||
Constructs a new instance of the `ApiClient` class | ||
|
||
|
||
</td></tr> | ||
</tbody></table> | ||
|
||
## Properties | ||
|
||
<table><thead><tr><th> | ||
|
||
Property | ||
|
||
|
||
</th><th> | ||
|
||
Modifiers | ||
|
||
|
||
</th><th> | ||
|
||
Type | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
[playlists](./youtubes.js.apiclient.playlists.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td><td> | ||
|
||
[PlaylistManager](./youtubes.js.playlistmanager.md) | ||
|
||
|
||
</td><td> | ||
|
||
The manager for playlists. Provides methods for fetching and manipulating playlists. | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [ApiClientOptions](./youtubes.js.apiclientoptions.md) | ||
|
||
## ApiClientOptions interface | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export interface ApiClientOptions | ||
``` | ||
|
||
## Properties | ||
|
||
<table><thead><tr><th> | ||
|
||
Property | ||
|
||
|
||
</th><th> | ||
|
||
Modifiers | ||
|
||
|
||
</th><th> | ||
|
||
Type | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
[logLevel?](./youtubes.js.apiclientoptions.loglevel.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td><td> | ||
|
||
[LogLevel](./youtubes.js.loglevel.md) | ||
|
||
|
||
</td><td> | ||
|
||
_(Optional)_ The log level for the client. | ||
|
||
|
||
</td></tr> | ||
<tr><td> | ||
|
||
[oauth](./youtubes.js.apiclientoptions.oauth.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td><td> | ||
|
||
[OAuthProviders](./youtubes.js.oauthproviders.md) | ||
|
||
|
||
</td><td> | ||
|
||
The OAuth providers to use. | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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; | ||
``` |
13 changes: 13 additions & 0 deletions
13
docs/api/youtubes.js.createplaylistoptions.defaultlanguage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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; | ||
``` |
16 changes: 16 additions & 0 deletions
16
docs/api/youtubes.js.createplaylistoptions.localizations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[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<string, { | ||
title: string; | ||
description: string; | ||
}>; | ||
``` |
Oops, something went wrong.