Skip to content

Commit

Permalink
chore(release): 0.4.3 [skip ci]
Browse files Browse the repository at this point in the history
## [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
semantic-release-bot committed Jan 20, 2025
1 parent 1104a36 commit 7a49a83
Show file tree
Hide file tree
Showing 10 changed files with 289 additions and 3 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
## [0.4.3](https://github.com/suzuki3jp/youtubes.js/compare/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](https://github.com/suzuki3jp/youtubes.js/commit/bb64f896415e129d726df2d306c4d232267a834a))
* Prevent `ErrorEXError [JSONError]: JSON Error in /home/runner/work/youtubes.js/youtubes.js/.releaserc.json` in CD ([0cd2870](https://github.com/suzuki3jp/youtubes.js/commit/0cd2870d56ff2b5115f5c900a3480ed6e02e77e6))


### Features

* **PlaylistItemManager:** Support `playlistItems.list` by playlistId ([005ec48](https://github.com/suzuki3jp/youtubes.js/commit/005ec483632ff278b08eb9319ad6fe0c45976ecc))

## [0.4.2](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.1...v0.4.2) (2025-01-20)

## [0.4.1](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.0...v0.4.1) (2025-01-19)
Expand Down
19 changes: 19 additions & 0 deletions docs/api/youtubes.js.apiclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,25 @@ Description
</th></tr></thead>
<tbody><tr><td>

[playlistItems](./youtubes.js.apiclient.playlistitems.md)


</td><td>


</td><td>

[PlaylistItemManager](./youtubes.js.playlistitemmanager.md)


</td><td>

A manager for playlist items. Provides methods for fetching and manipulating playlist items.


</td></tr>
<tr><td>

[playlists](./youtubes.js.apiclient.playlists.md)


Expand Down
13 changes: 13 additions & 0 deletions docs/api/youtubes.js.apiclient.playlistitems.md
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) &gt; [youtubes.js](./youtubes.js.md) &gt; [ApiClient](./youtubes.js.apiclient.md) &gt; [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;
```
22 changes: 22 additions & 0 deletions docs/api/youtubes.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,19 @@ Represents a YouTube playlist resource.
\[YouTube Data API Reference\](https://developers.google.com/youtube/v3/docs/playlists\#resource)


</td></tr>
<tr><td>

[PlaylistItemManager](./youtubes.js.playlistitemmanager.md)


</td><td>

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)


</td></tr>
<tr><td>

Expand Down Expand Up @@ -218,6 +231,15 @@ Description
</td><td>


</td></tr>
<tr><td>

[PlaylistItem](./youtubes.js.playlistitem.md)


</td><td>


</td></tr>
<tr><td>

Expand Down
11 changes: 11 additions & 0 deletions docs/api/youtubes.js.playlistitem.md
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) &gt; [youtubes.js](./youtubes.js.md) &gt; [PlaylistItem](./youtubes.js.playlistitem.md)

## PlaylistItem type

**Signature:**

```typescript
export type PlaylistItem = AvailablePlaylistItem | UnavailablePlaylistItem;
```
47 changes: 47 additions & 0 deletions docs/api/youtubes.js.playlistitemmanager._constructor_.md
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) &gt; [youtubes.js](./youtubes.js.md) &gt; [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) &gt; [(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 docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md
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) &gt; [youtubes.js](./youtubes.js.md) &gt; [PlaylistItemManager](./youtubes.js.playlistitemmanager.md) &gt; [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&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[PlaylistItem](./youtubes.js.playlistitem.md)<!-- -->\[\]&gt;, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;


87 changes: 87 additions & 0 deletions docs/api/youtubes.js.playlistitemmanager.md
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) &gt; [youtubes.js](./youtubes.js.md) &gt; [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>
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "youtubes.js",
"description": "A JavaScript client for YouTube Data API v3.",
"version": "0.4.2",
"version": "0.4.3",
"main": "dist/index.js",
"types": "dist/index.d.ts",
"keywords": [
Expand Down

0 comments on commit 7a49a83

Please sign in to comment.