Merge pull request #6 from suzuki3jp/develop

ci: Add job for generating API documentation
suzuki3jp · Jan 20, 2025 · ba7ce08 · ba7ce08
2 parents 517440b + bb64f89
commit ba7ce08
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 2 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,6 +5,19 @@ on:
   workflow_dispatch:
 
 jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm ci
+      - name: Generates api documentation
+        run: npm run docs
   vitest:
     runs-on: ubuntu-latest
     steps:

diff --git a/src/managers/PlaylistItemManager.ts b/src/managers/PlaylistItemManager.ts
@@ -38,8 +38,8 @@ export class PlaylistItemManager {
      * - The operation uses 1 quota unit.
      *
      * [YouTube Data API Reference](https://developers.google.com/youtube/v3/docs/playlistItems/list)
-     * @param playlistId
-     * @param pageToken
+     * @param playlistId - The ID of the playlist to retrieve items from.
+     * @param pageToken - The page token to use for pagination.
      * @returns
      */
     public async getByPlaylistId(