chore(release): 0.3.0 [skip ci]

# [0.3.0](v0.2.0...v0.3.0) (2025-01-19) ### Bug Fixes * **Pagination:** Improve nullish checks for resultsPerPage and totalResults in Pagination class ([aaeae08](aaeae08)) ### Features * Implement Result-based error handling ([6e1aaf0](6e1aaf0))
suzuki3jp · Jan 19, 2025 · 6c5cb2d · 6c5cb2d
1 parent 642cba0
commit 6c5cb2d
Show file tree

Hide file tree

Showing 18 changed files with 148 additions and 39 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+# [0.3.0](https://github.com/suzuki3jp/youtubes.js/compare/v0.2.0...v0.3.0) (2025-01-19)
+
+
+### Bug Fixes
+
+* **Pagination:** Improve nullish checks for resultsPerPage and totalResults in Pagination class ([aaeae08](https://github.com/suzuki3jp/youtubes.js/commit/aaeae082364668e1d721c1594315eed3851858f0))
+
+
+### Features
+
+* Implement Result-based error handling ([6e1aaf0](https://github.com/suzuki3jp/youtubes.js/commit/6e1aaf0f15750833ddc273b55519cb2893ef482a))
+
 # [0.2.0](https://github.com/suzuki3jp/youtubes.js/compare/v0.1.2...v0.2.0) (2025-01-18)
 
 

diff --git a/docs/api/youtubes.js.pagination.all.md b/docs/api/youtubes.js.pagination.all.md
@@ -9,11 +9,11 @@ Fetches all pages data. - \*\*NOTE\*\*: This method may consume unnecessary quot
 **Signature:**
 
 ```typescript
-all(): Promise<T[]>;
+all(): Promise<Result<T[], YouTubesJsErrors>>;
 ```
 **Returns:**
 
-Promise&lt;T\[\]&gt;
+Promise&lt;Result&lt;T\[\], YouTubesJsErrors&gt;&gt;
 
 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.
 

diff --git a/docs/api/youtubes.js.pagination.next.md b/docs/api/youtubes.js.pagination.next.md
@@ -9,11 +9,11 @@ Fetches the next page. - \*\*NOTE\*\*: This method will use the same quotas as t
 **Signature:**
 
 ```typescript
-next(): Promise<Pagination<T> | null>;
+next(): Promise<Result<Pagination<T>, YouTubesJsErrors> | null>;
 ```
 **Returns:**
 
-Promise&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt; \| null&gt;
+Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt;, YouTubesJsErrors&gt; \| null&gt;
 
 The next page. If there is no next page, returns `null`<!-- -->.
 

diff --git a/docs/api/youtubes.js.pagination.prev.md b/docs/api/youtubes.js.pagination.prev.md
@@ -9,11 +9,11 @@ Fetches the previous page. - \*\*NOTE\*\*: This method will use the same quotas
 **Signature:**
 
 ```typescript
-prev(): Promise<Pagination<T> | null>;
+prev(): Promise<Result<Pagination<T>, YouTubesJsErrors> | null>;
 ```
 **Returns:**
 
-Promise&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt; \| null&gt;
+Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt;, YouTubesJsErrors&gt; \| null&gt;
 
 The previous page. If there is no previous page, returns `null`<!-- -->.
 

diff --git a/docs/api/youtubes.js.paginationoptions.getwithtoken.md b/docs/api/youtubes.js.paginationoptions.getwithtoken.md
@@ -7,5 +7,5 @@
 **Signature:**
 
 ```typescript
-getWithToken: (token: string) => Promise<Pagination<T>>;
+getWithToken: (token: string) => Promise<Result<Pagination<T>, YouTubesJsErrors>>;
 ```
diff --git a/docs/api/youtubes.js.paginationoptions.md b/docs/api/youtubes.js.paginationoptions.md
@@ -60,7 +60,7 @@ T
 
 </td><td>
 
-(token: string) =&gt; Promise&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt;&gt;
+(token: string) =&gt; Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;T&gt;, YouTubesJsErrors&gt;&gt;
 
 
 </td><td>

diff --git a/docs/api/youtubes.js.playlist.from.md b/docs/api/youtubes.js.playlist.from.md
@@ -7,7 +7,7 @@
 **Signature:**
 
 ```typescript
-static from(data: youtube_v3.Schema$Playlist, logger: Logger): Result<Playlist, string>;
+static from(data: youtube_v3.Schema$Playlist, logger: Logger): Result<Playlist, LikelyBugError>;
 ```
 
 ## Parameters
@@ -59,5 +59,5 @@ Logger
 </tbody></table>
 **Returns:**
 
-Result&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->, string&gt;
+Result&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->, LikelyBugError&gt;
 
diff --git a/docs/api/youtubes.js.playlist.frommany.md b/docs/api/youtubes.js.playlist.frommany.md
@@ -0,0 +1,63 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [youtubes.js](./youtubes.js.md) &gt; [Playlist](./youtubes.js.playlist.md) &gt; [fromMany](./youtubes.js.playlist.frommany.md)
+
+## Playlist.fromMany() method
+
+**Signature:**
+
+```typescript
+static fromMany(data: youtube_v3.Schema$Playlist[], logger: Logger): Result<Playlist[], LikelyBugError>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+data
+
+
+</td><td>
+
+youtube\_v3.Schema$Playlist\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+logger
+
+
+</td><td>
+
+Logger
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Result&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\], LikelyBugError&gt;
+
diff --git a/docs/api/youtubes.js.playlist.md b/docs/api/youtubes.js.playlist.md
@@ -275,5 +275,19 @@ Description
 </td><td>
 
 
+</td></tr>
+<tr><td>
+
+[fromMany(data, logger)](./youtubes.js.playlist.frommany.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+
 </td></tr>
 </tbody></table>
diff --git a/docs/api/youtubes.js.playlistmanager.create.md b/docs/api/youtubes.js.playlistmanager.create.md
@@ -4,14 +4,16 @@
 
 ## 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
+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<Playlist>;
+create(options: CreatePlaylistOptions): Promise<Result<Playlist, YouTubesJsErrors>>;
 ```
 
 ## Parameters
@@ -51,5 +53,5 @@ Options for creating a playlist.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->&gt;
+Promise&lt;Result&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->, YouTubesJsErrors&gt;&gt;
 
diff --git a/docs/api/youtubes.js.playlistmanager.deletebyid.md b/docs/api/youtubes.js.playlistmanager.deletebyid.md
@@ -4,7 +4,9 @@
 
 ## PlaylistManager.deleteById() method
 
-Deletes a playlist by its ID. - This operation uses 50 quota units.
+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)
 

diff --git a/docs/api/youtubes.js.playlistmanager.getbychannelid.md b/docs/api/youtubes.js.playlistmanager.getbychannelid.md
@@ -4,14 +4,16 @@
 
 ## 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.
+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<Pagination<Playlist[]>>;
+getByChannelId(id: string, pageToken?: string): Promise<Result<Pagination<Playlist[]>, YouTubesJsErrors>>;
 ```
 
 ## Parameters
@@ -67,7 +69,7 @@ _(Optional)_ The token for pagination.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;&gt;
+Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;, YouTubesJsErrors&gt;&gt;
 
 ## Example
 
@@ -80,7 +82,7 @@ const oauth = new StaticOAuthProvider({
 });
 const client = new ApiClient({ oauth });
 
-const playlists = await client.playlists.getByChannelId("CHANNEL_ID");
-console.log(playlists.data); // Playlist[]
+// THIS IS UNSAFE ERROR HANDLING. See the safe error handling in the README.md Introduction.
+const playlists = (await client.playlists.getByChannelId("CHANNEL_ID")).throw(); // Pagination<Playlist[]>
 ```
 
diff --git a/docs/api/youtubes.js.playlistmanager.getbyids.md b/docs/api/youtubes.js.playlistmanager.getbyids.md
@@ -4,14 +4,16 @@
 
 ## PlaylistManager.getByIds() method
 
-Fetches a playlist by its ID. - This operation uses 1 quota unit.
+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
-getByIds(ids: string[], pageToken?: string): Promise<Pagination<Playlist[]>>;
+getByIds(ids: string[], pageToken?: string): Promise<Result<Pagination<Playlist[]>, YouTubesJsErrors>>;
 ```
 
 ## Parameters
@@ -67,7 +69,7 @@ _(Optional)_ The token for pagination.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;&gt;
+Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;, YouTubesJsErrors&gt;&gt;
 
 ## Example
 
@@ -80,7 +82,7 @@ const oauth = new StaticOAuthProvider({
 });
 const client = new ApiClient({ oauth });
 
-const playlists = await client.playlists.getByIds(["ID1", "ID2"]);
-console.log(playlists.data); // [Playlist, Playlist]
+// THIS IS UNSAFE ERROR HANDLING. See the safe error handling in the README.md Introduction.
+const playlists = (await client.playlists.getByIds(["ID1", "ID2"])).throw(); // Pagination<Playlist[]>
 ```
 
diff --git a/docs/api/youtubes.js.playlistmanager.getmine.md b/docs/api/youtubes.js.playlistmanager.getmine.md
@@ -4,14 +4,16 @@
 
 ## PlaylistManager.getMine() method
 
-Fetches the playlists owned by the authenticated user. - This operation uses 1 quota unit.
+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<Pagination<Playlist[]>>;
+getMine(pageToken?: string): Promise<Result<Pagination<Playlist[]>, YouTubesJsErrors>>;
 ```
 
 ## Parameters
@@ -51,7 +53,7 @@ _(Optional)_ The token for pagination.
 </tbody></table>
 **Returns:**
 
-Promise&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;&gt;
+Promise&lt;Result&lt;[Pagination](./youtubes.js.pagination.md)<!-- -->&lt;[Playlist](./youtubes.js.playlist.md)<!-- -->\[\]&gt;, YouTubesJsErrors&gt;&gt;
 
 ## Example
 
@@ -64,7 +66,7 @@ const oauth = new StaticOAuthProvider({
 });
 
 const client = new ApiClient({ oauth });
-const playlists = await client.playlists.getMine();
-console.log(playlists.data); // Playlist[]
+// THIS IS UNSAFE ERROR HANDLING. See the safe error handling in the README.md Introduction.
+const playlists = (await client.playlists.getMine()).throw(); // Pagination<Playlist[]>
 ```
 
diff --git a/docs/api/youtubes.js.playlistmanager.md b/docs/api/youtubes.js.playlistmanager.md
@@ -76,7 +76,9 @@ Description
 
 </td><td>
 
-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
+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)
 
@@ -92,7 +94,9 @@ Creates a playlist. - This operation uses 50 quota units. - There is a limit of
 
 </td><td>
 
-Deletes a playlist by its ID. - This operation uses 50 quota units.
+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)
 
@@ -108,7 +112,9 @@ Deletes a playlist by its ID. - This operation uses 50 quota units.
 
 </td><td>
 
-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.
+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)
 
@@ -124,7 +130,9 @@ Fetches the playlists of a channel by its ID. - This operation uses 1 quota unit
 
 </td><td>
 
-Fetches a playlist by its ID. - This operation uses 1 quota unit.
+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)
 
@@ -140,7 +148,9 @@ Fetches a playlist by its ID. - This operation uses 1 quota unit.
 
 </td><td>
 
-Fetches the playlists owned by the authenticated user. - This operation uses 1 quota unit.
+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.thumbnails.from.md b/docs/api/youtubes.js.thumbnails.from.md
@@ -9,7 +9,7 @@ Generates a `Thumbnails` instance from the YouTube API raw data.
 **Signature:**
 
 ```typescript
-static from(data: youtube_v3.Schema$ThumbnailDetails, logger: Logger): Result<Thumbnails, string>;
+static from(data: youtube_v3.Schema$ThumbnailDetails, logger: Logger): Result<Thumbnails, LikelyBugError>;
 ```
 
 ## Parameters
@@ -63,5 +63,5 @@ Logger
 </tbody></table>
 **Returns:**
 
-Result&lt;[Thumbnails](./youtubes.js.thumbnails.md)<!-- -->, string&gt;
+Result&lt;[Thumbnails](./youtubes.js.thumbnails.md)<!-- -->, LikelyBugError&gt;