@book000/twitterts 0.57.55 → 0.58.1

package/dist/twitter.d.ts

@@ -3,28 +3,147 @@ import { TwitterScraper, TwitterScraperOptions } from './scraper';
 import { GraphQLGetUserByScreenNameSuccessResponse } from './models/responses/graphql/get/user-by-screen-name-success';
 import { FullUser, Status } from 'twitter-d';
 import { CustomTweetObject } from './models/responses/custom/custom-tweet-object';
+/**
+ * {@link TwitterOptions} オプション
+ */
 export type TwitterOptions = TwitterScraperOptions;
+/**
+ * Twitter スクレイピングライブラリクラス
+ */
 export declare class Twitter {
     readonly scraper: TwitterScraper;
+    /**
+     * @param scraper {@link TwitterScraper} インスタンス
+     */
     private constructor();
+    /**
+     * Twitter にログインする
+     *
+     * @param options ログインオプション
+     * @returns Twitter インスタンス
+     */
     static login(options: TwitterOptions): Promise<Twitter>;
+    /**
+     * スクリーンネームからユーザー情報を取得する
+     *
+     * @param options ユーザー情報取得オプション
+     * @returns ユーザー情報
+     */
     getUserByScreenName(options: GetUserByScreenNameOptions): Promise<GraphQLGetUserByScreenNameSuccessResponse>;
+    /**
+     * ユーザー ID からスクリーンネームを取得する
+     *
+     * @param userId ユーザー ID
+     * @returns スクリーンネーム
+     */
     getScreenNameByUserId(options: GetScreenNameByUserIdOptions): Promise<string>;
+    /**
+     * ユーザー ID からスクリーンネームを取得する
+     *
+     * @param userId ユーザー ID
+     * @returns スクリーンネーム
+     */
     getUserByUserId(options: GetUserByUserIdOptions): Promise<FullUser>;
+    /**
+     * ユーザー ID からユーザー情報を取得する。ユーザー情報は生レスポンスで返す
+     *
+     * @param userId ユーザー ID
+     * @returns ユーザー情報（生レスポンス）
+     */
     getRawUserByUserId(options: GetUserByUserIdOptions): Promise<GraphQLGetUserByScreenNameSuccessResponse>;
+    /**
+     * ホームタイムラインのツイートを取得する。
+     *
+     * @param options ホームタイムライン取得オプション
+     * @returns ホームタイムラインのツイート
+     */
     getHomeTimelineTweets(options: GetHomeTimelineTweetsOptions): Promise<Status[]>;
+    /**
+     * ホームタイムラインのツイートを取得する。ツイートは非正規化ツイート（CustomTweetObject）で返す
+     *
+     * @param options ホームタイムライン取得オプション
+     * @returns ホームタイムラインのツイート（非正規化ツイート）
+     */
     getHomeTimelineRawTweets(options: GetHomeTimelineTweetsOptions): Promise<CustomTweetObject[]>;
+    /**
+     * ツイートを検索する。
+     *
+     * @param options 検索オプション
+     * @returns 検索結果
+     */
     searchTweets(options: SearchTweetsOptions): Promise<Status[]>;
+    /**
+     * ツイートを検索する。ツイートは非正規化ツイート（CustomTweetObject）で返す
+     *
+     * @param options 検索オプション
+     * @returns 検索結果（非正規化ツイート）
+     */
     searchRawTweets(options: SearchTweetsOptions): Promise<CustomTweetObject[]>;
+    /**
+     * ユーザーのツイートを取得する
+     *
+     * @param options ユーザーツイート取得オプション
+     * @returns ユーザーのツイート
+     */
     getUserTweets(options: GetUserTweetsOptions): Promise<Status[]>;
+    /**
+     * ユーザーのいいねしたツイートを取得する
+     *
+     * @param options ユーザーいいねツイート取得オプション
+     * @returns ユーザーのツイート
+     */
     getUserLikeTweets(options: GetUserLikeTweetsOptions): Promise<Status[]>;
+    /**
+     * ツイートの情報を取得する
+     *
+     * @param options ツイート取得オプション
+     * @returns ツイート
+     */
     getTweet(options: GetTweetOptions): Promise<Status>;
+    /**
+     * ツイートの生情報を取得する
+     *
+     * @param options ツイート取得オプション
+     * @returns ツイートの生情報
+     */
     getRawTweet(options: GetTweetOptions): Promise<CustomTweetObject>;
+    /**
+     * ツイートをいいねする
+     *
+     * @param options いいねオプション
+     * @returns いいねできたかどうかの文字列（Done）
+     */
     likeTweet(options: LikeTweetOptions): Promise<string | undefined>;
+    /**
+     * ツイートのいいねを解除する
+     *
+     * @param options いいね解除オプション
+     * @returns いいね解除できたかどうかの文字列（Done）
+     */
     unlikeTweet(options: UnlikeTweetOptions): Promise<string | undefined>;
+    /**
+     * ユーザーをブロックする
+     *
+     * @param options ブロックオプション
+     */
     blockUser(options: BlockUserOptions): Promise<void>;
+    /**
+     * ユーザーのブロックを解除する
+     *
+     * @param options ブロック解除オプション
+     */
     unblockUser(options: UnblockUserOptions): Promise<void>;
+    /**
+     * ブラウザを閉じる
+     */
     close(): Promise<void>;
+    /**
+     * エラーレスポンスかどうかを判定する。
+     * これを使うことでエラーがどうかは判定できるが、レスポンス型は保証されないので利用側で型保証されるメソッドを書いたほうがよい。
+     *
+     * @param response レスポンス
+     * @returns エラーレスポンスかどうか
+     */
     isErrorResponse(response: any): response is {
         errors: any[];
     };

package/dist/twitter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"twitter.d.ts","sourceRoot":"","sources":["../src/twitter.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,mBAAmB,EAEnB,wBAAwB,EACxB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,4BAA4B,EAE5B,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,WAAW,CAAA;AAIlB,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAGjE,OAAO,EAAE,yCAAyC,EAAE,MAAM,4DAA4D,CAAA;AACtH,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAA;AAMjF,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAA;AAKlD,qBAAa,OAAO;IAClB,SAAgB,OAAO,EAAE,cAAc,CAAA;IAKvC,OAAO;WAUa,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAYvD,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yCAAyC,CAAC;IAkCxC,qBAAqB,CAChC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,MAAM,CAAC;IAeL,eAAe,CAC1B,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,QAAQ,CAAC;IAeP,kBAAkB,CAC7B,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,yCAAyC,CAAC;IAyCxC,qBAAqB,CAChC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,MAAM,EAAE,CAAC;IAcP,wBAAwB,CACnC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAoFlB,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAc7D,eAAe,CAC1B,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IA+DlB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IA0D/D,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,MAAM,EAAE,CAAC;IA8DP,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAWnD,WAAW,CACtB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,iBAAiB,CAAC;IA0DhB,SAAS,CACpB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA6FjB,WAAW,CACtB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IA4FjB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkEnD,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuDvD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAW5B,eAAe,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI;QAAE,MAAM,EAAE,GAAG,EAAE,CAAA;KAAE;YAItD,aAAa;CAwB5B"}
+{"version":3,"file":"twitter.d.ts","sourceRoot":"","sources":["../src/twitter.ts"],"names":[],"mappings":"AAYA,OAAO,EACL,0BAA0B,EAC1B,gBAAgB,EAChB,mBAAmB,EAEnB,wBAAwB,EACxB,oBAAoB,EACpB,4BAA4B,EAC5B,sBAAsB,EACtB,kBAAkB,EAClB,4BAA4B,EAE5B,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EAChB,MAAM,WAAW,CAAA;AAIlB,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAGjE,OAAO,EAAE,yCAAyC,EAAE,MAAM,4DAA4D,CAAA;AACtH,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAA;AAGjF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,qBAAqB,CAAA;AAElD;;GAEG;AACH,qBAAa,OAAO;IAClB,SAAgB,OAAO,EAAE,cAAc,CAAA;IAEvC;;OAEG;IACH,OAAO;IAIP;;;;;OAKG;WACiB,KAAK,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC;IAMpE;;;;;OAKG;IACU,mBAAmB,CAC9B,OAAO,EAAE,0BAA0B,GAClC,OAAO,CAAC,yCAAyC,CAAC;IA4BrD;;;;;OAKG;IACU,qBAAqB,CAChC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,MAAM,CAAC;IASlB;;;;;OAKG;IACU,eAAe,CAC1B,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,QAAQ,CAAC;IASpB;;;;;OAKG;IACU,kBAAkB,CAC7B,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,yCAAyC,CAAC;IAmCrD;;;;;OAKG;IACU,qBAAqB,CAChC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,MAAM,EAAE,CAAC;IAQpB;;;;;OAKG;IACU,wBAAwB,CACnC,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,iBAAiB,EAAE,CAAC;IA8E/B;;;;;OAKG;IACU,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAQ1E;;;;;OAKG;IACU,eAAe,CAC1B,OAAO,EAAE,mBAAmB,GAC3B,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAyD/B;;;;;OAKG;IACU,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAoD5E;;;;;OAKG;IACU,iBAAiB,CAC5B,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,MAAM,EAAE,CAAC;IAwDpB;;;;;OAKG;IACU,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC;IAKhE;;;;;OAKG;IACU,WAAW,CACtB,OAAO,EAAE,eAAe,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAoD7B;;;;;OAKG;IACU,SAAS,CACpB,OAAO,EAAE,gBAAgB,GACxB,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAuF9B;;;;;OAKG;IACU,WAAW,CACtB,OAAO,EAAE,kBAAkB,GAC1B,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAuF9B;;;;OAIG;IACU,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6DhE;;;;OAIG;IACU,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoDpE;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;;;OAMG;IACI,eAAe,CAAC,QAAQ,EAAE,GAAG,GAAG,QAAQ,IAAI;QAAE,MAAM,EAAE,GAAG,EAAE,CAAA;KAAE;YAItD,aAAa;CAwB5B"}

package/dist/twitter.js

@@ -10,15 +10,33 @@ const user_tweets_1 = require("./parser/user-tweets");
 const scraper_1 = require("./scraper");
 const converter_1 = require("./converter");
 const home_timeline_parser_1 = require("./parser/home-timeline-parser");
+/**
+ * Twitter スクレイピングライブラリクラス
+ */
 class Twitter {
+    /**
+     * @param scraper {@link TwitterScraper} インスタンス
+     */
     constructor(scraper) {
         this.scraper = scraper;
     }
+    /**
+     * Twitter にログインする
+     *
+     * @param options ログインオプション
+     * @returns Twitter インスタンス
+     */
     static async login(options) {
         const scraper = new scraper_1.TwitterScraper(options);
         await scraper.login();
         return new Twitter(scraper);
     }
+    /**
+     * スクリーンネームからユーザー情報を取得する
+     *
+     * @param options ユーザー情報取得オプション
+     * @returns ユーザー情報
+     */
     async getUserByScreenName(options) {
         if (!options.screenName) {
             throw new exceptions_1.IllegalArgumentError('screenName is required');
@@ -42,6 +60,12 @@ class Twitter {
         }
         return response;
     }
+    /**
+     * ユーザー ID からスクリーンネームを取得する
+     *
+     * @param userId ユーザー ID
+     * @returns スクリーンネーム
+     */
     async getScreenNameByUserId(options) {
         if (!options.userId) {
             throw new exceptions_1.IllegalArgumentError('userId is required');
@@ -49,6 +73,12 @@ class Twitter {
         const user = await this.getRawUserByUserId(options);
         return user.data.user.result.legacy.screen_name;
     }
+    /**
+     * ユーザー ID からスクリーンネームを取得する
+     *
+     * @param userId ユーザー ID
+     * @returns スクリーンネーム
+     */
     async getUserByUserId(options) {
         if (!options.userId) {
             throw new exceptions_1.IllegalArgumentError('userId is required');
@@ -56,13 +86,21 @@ class Twitter {
         const user = await this.getRawUserByUserId(options);
         return converter_1.ObjectConverter.convertToFullUser(user);
     }
+    /**
+     * ユーザー ID からユーザー情報を取得する。ユーザー情報は生レスポンスで返す
+     *
+     * @param userId ユーザー ID
+     * @returns ユーザー情報（生レスポンス）
+     */
     async getRawUserByUserId(options) {
+        // TODO: ユーザー情報をv1.1あたりのモデルに変換する処理を入れた方がいい
         if (!options.userId) {
             throw new exceptions_1.IllegalArgumentError('userId is required');
         }
         const page = await this.scraper.getScraperPage();
         let response;
         try {
+            // UserByRestIdだとログインユーザー自分自身の場合に取得できない。
             response = await page.waitSingleResponse(`https://twitter.com/intent/user?user_id=${options.userId}`, 'GET', 'GRAPHQL', 'UserByScreenName');
         }
         catch (error) {
@@ -82,11 +120,25 @@ class Twitter {
         }
         return response;
     }
+    /**
+     * ホームタイムラインのツイートを取得する。
+     *
+     * @param options ホームタイムライン取得オプション
+     * @returns ホームタイムラインのツイート
+     */
     async getHomeTimelineTweets(options) {
         const rawTweets = await this.getHomeTimelineRawTweets(options);
         return rawTweets.map((rawTweet) => converter_1.ObjectConverter.convertToStatus(rawTweet));
     }
+    /**
+     * ホームタイムラインのツイートを取得する。ツイートは非正規化ツイート（CustomTweetObject）で返す
+     *
+     * @param options ホームタイムライン取得オプション
+     * @returns ホームタイムラインのツイート（非正規化ツイート）
+     */
     async getHomeTimelineRawTweets(options) {
+        // おすすめタブ: HomeTimeline
+        // フォロー中タブ: HomeLatestTimeline
         if (!options.timelineType) {
             throw new exceptions_1.IllegalArgumentError('timelineType is required');
         }
@@ -102,6 +154,7 @@ class Twitter {
         const results = [];
         try {
             await page.goto(url);
+            // タブ選択
             const tabs = await page.page.$$('nav[aria-live="polite"] div[role="tablist"] > div');
             const tabIndex = options.timelineType === options_1.TimelineType.RECOMMEND ? 0 : 1;
             if (!tabs[tabIndex]) {
@@ -111,6 +164,7 @@ class Twitter {
             let lastResponseAt = Date.now();
             while (true) {
                 if (Date.now() - lastResponseAt > 1000 * 30) {
+                    // 30秒以上レスポンスがない場合はタイムアウトとして終了
                     break;
                 }
                 const getResponse = page.shiftResponse('GET', 'GRAPHQL', endpointName);
@@ -144,10 +198,22 @@ class Twitter {
         }
         return results;
     }
+    /**
+     * ツイートを検索する。
+     *
+     * @param options 検索オプション
+     * @returns 検索結果
+     */
     async searchTweets(options) {
         const rawTweets = await this.searchRawTweets(options);
         return rawTweets.map((rawTweet) => converter_1.ObjectConverter.convertToStatus(rawTweet));
     }
+    /**
+     * ツイートを検索する。ツイートは非正規化ツイート（CustomTweetObject）で返す
+     *
+     * @param options 検索オプション
+     * @returns 検索結果（非正規化ツイート）
+     */
     async searchRawTweets(options) {
         if (!options.query) {
             throw new exceptions_1.IllegalArgumentError('query is required');
@@ -167,6 +233,7 @@ class Twitter {
             let lastResponseAt = Date.now();
             while (true) {
                 if (Date.now() - lastResponseAt > 1000 * 30) {
+                    // 30秒以上レスポンスがない場合はタイムアウトとして終了
                     break;
                 }
                 const response = page.shiftResponse('GET', 'GRAPHQL', 'SearchTimeline');
@@ -197,6 +264,12 @@ class Twitter {
         }
         return results;
     }
+    /**
+     * ユーザーのツイートを取得する
+     *
+     * @param options ユーザーツイート取得オプション
+     * @returns ユーザーのツイート
+     */
     async getUserTweets(options) {
         if (!options.screenName) {
             throw new exceptions_1.IllegalArgumentError('screenName is required');
@@ -214,6 +287,7 @@ class Twitter {
             let lastResponseAt = Date.now();
             while (true) {
                 if (Date.now() - lastResponseAt > 1000 * 30) {
+                    // 30秒以上レスポンスがない場合はタイムアウトとして終了
                     break;
                 }
                 const response = page.shiftResponse('GET', 'GRAPHQL', 'UserTweets');
@@ -244,6 +318,12 @@ class Twitter {
         }
         return results;
     }
+    /**
+     * ユーザーのいいねしたツイートを取得する
+     *
+     * @param options ユーザーいいねツイート取得オプション
+     * @returns ユーザーのツイート
+     */
     async getUserLikeTweets(options) {
         if (!options.screenName) {
             throw new exceptions_1.IllegalArgumentError('screenName is required');
@@ -261,6 +341,7 @@ class Twitter {
             let lastResponseAt = Date.now();
             while (true) {
                 if (Date.now() - lastResponseAt > 1000 * 30) {
+                    // 30秒以上レスポンスがない場合はタイムアウトとして終了
                     break;
                 }
                 const response = page.shiftResponse('GET', 'GRAPHQL', 'Likes');
@@ -291,10 +372,22 @@ class Twitter {
         }
         return results;
     }
+    /**
+     * ツイートの情報を取得する
+     *
+     * @param options ツイート取得オプション
+     * @returns ツイート
+     */
     async getTweet(options) {
         const rawTweet = await this.getRawTweet(options);
         return converter_1.ObjectConverter.convertToStatus(rawTweet);
     }
+    /**
+     * ツイートの生情報を取得する
+     *
+     * @param options ツイート取得オプション
+     * @returns ツイートの生情報
+     */
     async getRawTweet(options) {
         if (!options.tweetId) {
             throw new exceptions_1.IllegalArgumentError('tweetId is required');
@@ -326,23 +419,40 @@ class Twitter {
         }
         catch (error) {
             await page.close();
+            // if timeout
             if (error instanceof puppeteer_core_1.TimeoutError) {
                 throw new exceptions_1.TwitterTimeoutError('Failed to operate twitter');
             }
             throw error;
         }
     }
+    /**
+     * ツイートをいいねする
+     *
+     * @param options いいねオプション
+     * @returns いいねできたかどうかの文字列（Done）
+     */
     async likeTweet(options) {
         if (!options.tweetId) {
             throw new exceptions_1.IllegalArgumentError('tweetId is required');
         }
         const page = await this.scraper.getScraperPage();
+        // ツイートページを開く (30sec timeout)
+        // -> 削除済みその他でツイートが存在しない場合は TwitterOperationError を投げる (TweetDetail のレスポンスがerrorになる)
+        // いいねボタンが表示されるまで待つ (10sec timeout)
+        // -> いいねボタンがすでにクリック済みの場合は AlreadyLikedError を投げる
+        // -> いいねボタンが表示されなかった場合は TwitterOperationError を投げる
+        // いいねボタンをクリックする
+        // いいね完了まで待つ (10sec timeout)
+        // -> いいね完了しなかった場合は TwitterOperationError を投げる
+        // ツイートページを閉じる
         try {
             const url = `https://twitter.com/i/status/${options.tweetId}`;
             const responseDetail = await page.waitSingleResponse(url, 'GET', 'GRAPHQL', 'TweetDetail', 30000);
             if (!responseDetail) {
                 throw new exceptions_1.TwitterOperationError('Failed to get tweet detail');
             }
+            // いいねボタンが表示されるまで待つ
             const likeButtonSelector = 'article[tabindex="-1"] div[role="button"][data-testid="like"]';
             const unlikeButtonSelector = 'article[tabindex="-1"] div[role="button"][data-testid="unlike"]';
             const likeButton = await page.page.waitForSelector(`${likeButtonSelector}, ${unlikeButtonSelector}`, {
@@ -358,34 +468,54 @@ class Twitter {
             if (isLiked) {
                 throw new exceptions_1.AlreadyLikedError();
             }
+            // いいねボタンをクリックする
             const responseFavoritePromise = page.waitSingleResponse(null, 'POST', 'GRAPHQL', 'FavoriteTweet', 10000);
             await page.waitAndClick(likeButtonSelector, true);
+            // いいね完了まで待つ
             const responseFavorite = await responseFavoritePromise;
             if (!responseFavorite) {
                 throw new exceptions_1.TwitterOperationError('Failed to favorite tweet');
             }
+            // ツイートページを閉じる
             await page.close();
             return responseFavorite.data.favorite_tweet;
         }
         catch (error) {
             await page.close();
+            // if timeout
             if (error instanceof puppeteer_core_1.TimeoutError) {
                 throw new exceptions_1.TwitterTimeoutError('Failed to operate twitter');
             }
             throw error;
         }
     }
+    /**
+     * ツイートのいいねを解除する
+     *
+     * @param options いいね解除オプション
+     * @returns いいね解除できたかどうかの文字列（Done）
+     */
     async unlikeTweet(options) {
         if (!options.tweetId) {
             throw new exceptions_1.IllegalArgumentError('tweetId is required');
         }
         const page = await this.scraper.getScraperPage();
+        // ツイートページを開く (30sec timeout)
+        // -> 削除済みその他でツイートが存在しない場合は TwitterOperationError を投げる (TweetDetail のレスポンスがerrorになる)
+        // いいね済みボタンが表示されるまで待つ (10sec timeout)
+        // -> いいねボタンがすでにクリック済みではない場合は NotLikedError を投げる
+        // -> いいねボタンが表示されなかった場合は TwitterOperationError を投げる
+        // いいねボタンをクリックする
+        // いいね完了まで待つ (10sec timeout)
+        // -> いいね完了しなかった場合は TwitterOperationError を投げる
+        // ツイートページを閉じる
         try {
             const url = `https://twitter.com/i/status/${options.tweetId}`;
             const responseDetail = await page.waitSingleResponse(url, 'GET', 'GRAPHQL', 'TweetDetail', 30000);
             if (!responseDetail) {
                 throw new exceptions_1.TwitterOperationError('Failed to get tweet detail');
             }
+            // いいねボタンが表示されるまで待つ
             const likeButtonSelector = 'article[tabindex="-1"] div[role="button"][data-testid="like"]';
             const unlikeButtonSelector = 'article[tabindex="-1"] div[role="button"][data-testid="unlike"]';
             const unlikeButton = await page.page.waitForSelector(`${likeButtonSelector}, ${unlikeButtonSelector}`, {
@@ -401,23 +531,32 @@ class Twitter {
             if (!isLiked) {
                 throw new exceptions_1.NotLikedError();
             }
+            // いいねボタンをクリックする
             const responseFavoritePromise = page.waitSingleResponse(null, 'POST', 'GRAPHQL', 'UnfavoriteTweet', 10000);
             await page.waitAndClick(unlikeButtonSelector, true);
+            // いいね完了まで待つ
             const responseFavorite = await responseFavoritePromise;
             if (!responseFavorite) {
                 throw new exceptions_1.TwitterOperationError('Failed to favorite tweet');
             }
+            // ツイートページを閉じる
             await page.close();
             return responseFavorite.data.unfavorite_tweet;
         }
         catch (error) {
             await page.close();
+            // if timeout
             if (error instanceof puppeteer_core_1.TimeoutError) {
                 throw new exceptions_1.TwitterTimeoutError('Failed to operate twitter');
             }
             throw error;
         }
     }
+    /**
+     * ユーザーをブロックする
+     *
+     * @param options ブロックオプション
+     */
     async blockUser(options) {
         if (!options.screenName && !options.userId) {
             throw new exceptions_1.IllegalArgumentError('screenName or userId is required');
@@ -431,6 +570,7 @@ class Twitter {
             if (this.isErrorResponse(response)) {
                 throw new exceptions_1.TwitterOperationError(response.errors[0].message);
             }
+            // プロフィールの表示制限
             const viewProfileButton = await page.page.$('div[data-testid="emptyState"] div[role="button"]');
             if (viewProfileButton) {
                 await viewProfileButton.click();
@@ -441,6 +581,7 @@ class Twitter {
                 throw new exceptions_1.TwitterOperationError('Failed to get user status');
             }
             if (userStatus === 'unblock') {
+                // 既にブロック済み
                 throw new exceptions_1.AlreadyBlockedError();
             }
             await page.waitAndClick('div[data-testid="userActions"]', true);
@@ -453,12 +594,18 @@ class Twitter {
         }
         catch (error) {
             await page.close();
+            // if timeout
             if (error instanceof puppeteer_core_1.TimeoutError) {
                 throw new exceptions_1.TwitterTimeoutError('Failed to operate twitter');
             }
             throw error;
         }
     }
+    /**
+     * ユーザーのブロックを解除する
+     *
+     * @param options ブロック解除オプション
+     */
     async unblockUser(options) {
         if (!options.screenName && !options.userId) {
             throw new exceptions_1.IllegalArgumentError('screenName or userId is required');
@@ -469,6 +616,7 @@ class Twitter {
         const page = await this.scraper.getScraperPage();
         await page.goto(url);
         try {
+            // プロフィールの表示制限
             const viewProfileButton = await page.page.$('div[data-testid="emptyState"] div[role="button"]');
             if (viewProfileButton) {
                 await viewProfileButton.click();
@@ -479,6 +627,7 @@ class Twitter {
                 throw new exceptions_1.TwitterOperationError('Failed to get user status');
             }
             if (userStatus !== 'unblock') {
+                // 既にブロック解除済み
                 throw new exceptions_1.NotBlockedError();
             }
             await page.waitAndClick('div[data-testid="userActions"]', true);
@@ -491,19 +640,32 @@ class Twitter {
         }
         catch (error) {
             await page.close();
+            // if timeout
             if (error instanceof puppeteer_core_1.TimeoutError) {
                 throw new exceptions_1.TwitterTimeoutError('Failed to operate twitter');
             }
             throw error;
         }
     }
+    /**
+     * ブラウザを閉じる
+     */
     async close() {
         await this.scraper.close();
     }
+    /**
+     * エラーレスポンスかどうかを判定する。
+     * これを使うことでエラーがどうかは判定できるが、レスポンス型は保証されないので利用側で型保証されるメソッドを書いたほうがよい。
+     *
+     * @param response レスポンス
+     * @returns エラーレスポンスかどうか
+     */
     isErrorResponse(response) {
         return response.errors && response.errors.length > 0;
     }
     async getUserStatus(page) {
+        // 1234567890-follow
+        // 1234567890-unblock
         const testId = await page.evaluate(() => {
             return new Promise((resolve) => {
                 const interval = setInterval(() => {
@@ -515,7 +677,7 @@ class Twitter {
                 setTimeout(() => {
                     clearInterval(interval);
                     resolve();
-                }, 1000 * 60 * 2);
+                }, 1000 * 60 * 2); // 2分
             });
         });
         return testId;