-
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.4.3](v0.4.2...v0.4.3) (2025-01-20) ### Bug Fixes * **PlaylistItemManager:** Prevent `tsdoc-param-tag-missing-hyphen` error in `api-extractor` CI job ([bb64f89](bb64f89)) * Prevent `ErrorEXError [JSONError]: JSON Error in /home/runner/work/youtubes.js/youtubes.js/.releaserc.json` in CD ([0cd2870](0cd2870)) ### Features * **PlaylistItemManager:** Support `playlistItems.list` by playlistId ([005ec48](005ec48))
- Loading branch information
1 parent
1104a36
commit 7a49a83
Showing
10 changed files
with
289 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
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) > [playlistItems](./youtubes.js.apiclient.playlistitems.md) | ||
|
||
## ApiClient.playlistItems property | ||
|
||
A manager for playlist items. Provides methods for fetching and manipulating playlist items. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
playlistItems: PlaylistItemManager; | ||
``` |
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,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItem](./youtubes.js.playlistitem.md) | ||
|
||
## PlaylistItem type | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type PlaylistItem = AvailablePlaylistItem | UnavailablePlaylistItem; | ||
``` |
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) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) > [(constructor)](./youtubes.js.playlistitemmanager._constructor_.md) | ||
|
||
## PlaylistItemManager.(constructor) | ||
|
||
Constructs a new instance of the `PlaylistItemManager` class | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
constructor({ oauth, logger }: PlaylistItemManagerOptions); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table><thead><tr><th> | ||
|
||
Parameter | ||
|
||
|
||
</th><th> | ||
|
||
Type | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
{ oauth, logger } | ||
|
||
|
||
</td><td> | ||
|
||
PlaylistItemManagerOptions | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
74 changes: 74 additions & 0 deletions
74
docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.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,74 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) > [getByPlaylistId](./youtubes.js.playlistitemmanager.getbyplaylistid.md) | ||
|
||
## PlaylistItemManager.getByPlaylistId() method | ||
|
||
Retrieves a list of playlist items by a playlist ID. | ||
|
||
- The operation uses 1 quota unit. | ||
|
||
\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlistItems/list) | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
getByPlaylistId(playlistId: string, pageToken?: string): Promise<Result<Pagination<PlaylistItem[]>, YouTubesJsErrors>>; | ||
``` | ||
|
||
## Parameters | ||
|
||
<table><thead><tr><th> | ||
|
||
Parameter | ||
|
||
|
||
</th><th> | ||
|
||
Type | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
playlistId | ||
|
||
|
||
</td><td> | ||
|
||
string | ||
|
||
|
||
</td><td> | ||
|
||
The ID of the playlist to retrieve items from. | ||
|
||
|
||
</td></tr> | ||
<tr><td> | ||
|
||
pageToken | ||
|
||
|
||
</td><td> | ||
|
||
string | ||
|
||
|
||
</td><td> | ||
|
||
_(Optional)_ The page token to use for pagination. | ||
|
||
|
||
</td></tr> | ||
</tbody></table> | ||
**Returns:** | ||
|
||
Promise<Result<[Pagination](./youtubes.js.pagination.md)<!-- --><[PlaylistItem](./youtubes.js.playlistitem.md)<!-- -->\[\]>, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.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,87 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [youtubes.js](./youtubes.js.md) > [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) | ||
|
||
## PlaylistItemManager class | ||
|
||
A manager of playlist items belonging to a client. Provides methods for `/youtube/v3/playlistItems` | ||
|
||
\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlistItems) | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare class PlaylistItemManager | ||
``` | ||
|
||
## Constructors | ||
|
||
<table><thead><tr><th> | ||
|
||
Constructor | ||
|
||
|
||
</th><th> | ||
|
||
Modifiers | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
[(constructor)({ oauth, logger })](./youtubes.js.playlistitemmanager._constructor_.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td><td> | ||
|
||
Constructs a new instance of the `PlaylistItemManager` class | ||
|
||
|
||
</td></tr> | ||
</tbody></table> | ||
|
||
## Methods | ||
|
||
<table><thead><tr><th> | ||
|
||
Method | ||
|
||
|
||
</th><th> | ||
|
||
Modifiers | ||
|
||
|
||
</th><th> | ||
|
||
Description | ||
|
||
|
||
</th></tr></thead> | ||
<tbody><tr><td> | ||
|
||
[getByPlaylistId(playlistId, pageToken)](./youtubes.js.playlistitemmanager.getbyplaylistid.md) | ||
|
||
|
||
</td><td> | ||
|
||
|
||
</td><td> | ||
|
||
Retrieves a list of playlist items by a playlist ID. | ||
|
||
- The operation uses 1 quota unit. | ||
|
||
\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlistItems/list) | ||
|
||
|
||
</td></tr> | ||
</tbody></table> |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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