Skip to content

Commit

Permalink
chore(release): 0.5.0 [skip ci]
Browse files Browse the repository at this point in the history
# [0.5.0](v0.4.5...v0.5.0) (2025-01-22)

### Features

* Support `playlistItems.delete` ([8bc6700](8bc6700))
  • Loading branch information
semantic-release-bot committed Jan 22, 2025
1 parent d010207 commit 18154d0
Show file tree
Hide file tree
Showing 21 changed files with 149 additions and 72 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
# [0.5.0](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.5...v0.5.0) (2025-01-22)


### Features

* Support `playlistItems.delete` ([8bc6700](https://github.com/suzuki3jp/youtubes.js/commit/8bc670063b629caab5e9c63ccd08e8ee0d330ce5))

## [0.4.5](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.4...v0.4.5) (2025-01-21)

## [0.4.4](https://github.com/suzuki3jp/youtubes.js/compare/v0.4.3...v0.4.4) (2025-01-21)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/youtubes.js.likelybugerror.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Represents an error that is likely a bug in the library.

If you encounter this error, please report the issue on \[GitHub Issue\](https://github.com/suzuki3jp/youtubes.js/issues/new).
If you encounter this error, please report the issue on [GitHub Issue](https://github.com/suzuki3jp/youtubes.js/issues/new)<!-- -->.

**Signature:**

Expand Down
2 changes: 1 addition & 1 deletion docs/api/youtubes.js.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The main class for interacting with the YouTube Data API.

Represents an error that is likely a bug in the library.

If you encounter this error, please report the issue on \[GitHub Issue\](https://github.com/suzuki3jp/youtubes.js/issues/new).
If you encounter this error, please report the issue on [GitHub Issue](https://github.com/suzuki3jp/youtubes.js/issues/new)<!-- -->.


</td></tr>
Expand Down
6 changes: 5 additions & 1 deletion docs/api/youtubes.js.pagination.all.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 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).
Fetches all pages data.

**Signature:**

Expand All @@ -17,6 +17,10 @@ Promise&lt;Result&lt;T\[\], [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md

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.

## Remarks

- 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).

## Example


Expand Down
8 changes: 4 additions & 4 deletions docs/api/youtubes.js.pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ number

</td><td>

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.
The total number of results in the result set.


</td></tr>
Expand Down Expand Up @@ -156,7 +156,7 @@ Description

</td><td>

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).
Fetches all pages data.


</td></tr>
Expand All @@ -170,7 +170,7 @@ Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quot

</td><td>

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)
Fetches the next page.


</td></tr>
Expand All @@ -184,7 +184,7 @@ Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as t

</td><td>

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)
Fetches the previous page.


</td></tr>
Expand Down
6 changes: 5 additions & 1 deletion docs/api/youtubes.js.pagination.next.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 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)
Fetches the next page.

**Signature:**

Expand All @@ -17,6 +17,10 @@ Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt;,

The next page. If there is no next page, returns `null`<!-- -->.

## Remarks

- 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)

## Example


Expand Down
6 changes: 5 additions & 1 deletion docs/api/youtubes.js.pagination.prev.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 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)
Fetches the previous page.

**Signature:**

Expand All @@ -17,6 +17,10 @@ Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt;,

The previous page. If there is no previous page, returns `null`<!-- -->.

## Remarks

- 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)

## Example


Expand Down
7 changes: 6 additions & 1 deletion docs/api/youtubes.js.pagination.totalresults.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@

## 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.
The total number of results in the result set.

**Signature:**

```typescript
totalResults: number;
```

## Remarks

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.

6 changes: 4 additions & 2 deletions docs/api/youtubes.js.playlistitemmanager.create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@

Adds a item to a playlist.

- The operation uses 50 quota units.

**Signature:**

```typescript
Expand Down Expand Up @@ -55,3 +53,7 @@ Promise&lt;Result&lt;[PlaylistItem](./youtubes.js.playlistitem.md)<!-- -->, [You

- The created playlist item.

## Remarks

The operation uses 50 quota units.

53 changes: 53 additions & 0 deletions docs/api/youtubes.js.playlistitemmanager.deletebyid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!-- 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; [deleteById](./youtubes.js.playlistitemmanager.deletebyid.md)

## PlaylistItemManager.deleteById() method

Deletes a playlist item by its ID.

**Signature:**

```typescript
deleteById(id: string): Promise<Result<undefined, YouTubesJsErrors>>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

id


</td><td>

string


</td><td>

The ID of the playlist item to delete.


</td></tr>
</tbody></table>
**Returns:**

Promise&lt;Result&lt;undefined, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;

10 changes: 6 additions & 4 deletions docs/api/youtubes.js.playlistitemmanager.getbyplaylistid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@

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
Expand Down Expand Up @@ -72,3 +68,9 @@ _(Optional)_ The page token to use for pagination.
Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[PlaylistItem](./youtubes.js.playlistitem.md)<!-- -->\[\]&gt;, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;


## Remarks

The operation uses 1 quota unit.

[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlistItems/list)

18 changes: 13 additions & 5 deletions docs/api/youtubes.js.playlistitemmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,19 @@ Description

Adds a item to a playlist.

- The operation uses 50 quota units.

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

[deleteById(id)](./youtubes.js.playlistitemmanager.deletebyid.md)


</td><td>


</td><td>

Deletes a playlist item by its ID.


</td></tr>
Expand All @@ -94,10 +106,6 @@ Adds a item to a playlist.

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>
10 changes: 6 additions & 4 deletions docs/api/youtubes.js.playlistmanager.create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@

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
Expand Down Expand Up @@ -55,3 +51,9 @@ Options for creating a playlist.

Promise&lt;Result&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;

## Remarks

- 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)

10 changes: 6 additions & 4 deletions docs/api/youtubes.js.playlistmanager.deletebyid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@

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
Expand Down Expand Up @@ -55,3 +51,9 @@ The ID of the playlist.

Promise&lt;void&gt;

## Remarks

This operation uses 50 quota units.

[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/delete)

10 changes: 6 additions & 4 deletions docs/api/youtubes.js.playlistmanager.getbychannelid.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@

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
Expand Down Expand Up @@ -71,6 +67,12 @@ _(Optional)_ The token for pagination.

Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;

## Remarks

- 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)

## Example


Expand Down
10 changes: 6 additions & 4 deletions docs/api/youtubes.js.playlistmanager.getbyids.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@

Fetches a playlist by its ID.

- This operation uses 1 quota unit. - Note: The YouTube API returns empty data instead of an error when a playlist with the specified ID is not found.

[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list)

**Signature:**

```typescript
Expand Down Expand Up @@ -71,6 +67,12 @@ _(Optional)_ The token for pagination.

Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;

## Remarks

- This operation uses 1 quota unit. - Note: The YouTube API returns empty data instead of an error when a playlist with the specified ID is not found.

[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list)

## Example


Expand Down
10 changes: 6 additions & 4 deletions docs/api/youtubes.js.playlistmanager.getmine.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@

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
Expand Down Expand Up @@ -55,6 +51,12 @@ _(Optional)_ The token for pagination.

Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;, [YouTubesJsErrors](./youtubes.js.youtubesjserrors.md)<!-- -->&gt;&gt;

## Remarks

This operation uses 1 quota unit.

[YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlists/list)

## Example


Expand Down
Loading

0 comments on commit 18154d0

Please sign in to comment.