Class Twitter

Readonlyscraper

blockUser

• blockUser(options: BlockUserOptions): Promise<void>

  ユーザーをブロックする

  Parameters

  • options: BlockUserOptions

    ブロックオプション

  Returns Promise<void>

close

• close(): Promise<void>

  ブラウザを閉じる

  Returns Promise<void>

getHomeTimelineRawTweets

• getHomeTimelineRawTweets(
      options: GetHomeTimelineTweetsOptions,
  ): Promise<CustomTweetObject[]>

  ホームタイムラインのツイートを取得する。ツイートは非正規化ツイート（CustomTweetObject）で返す

  Parameters

  • options: GetHomeTimelineTweetsOptions

    ホームタイムライン取得オプション

  Returns Promise<CustomTweetObject[]>

  ホームタイムラインのツイート（非正規化ツイート）

getHomeTimelineTweets

• getHomeTimelineTweets(options: GetHomeTimelineTweetsOptions): Promise<Status[]>

  ホームタイムラインのツイートを取得する。

  Parameters

  • options: GetHomeTimelineTweetsOptions

    ホームタイムライン取得オプション

  Returns Promise<Status[]>

  ホームタイムラインのツイート

getRawTweet

• getRawTweet(options: GetTweetOptions): Promise<CustomTweetObject>

  ツイートの生情報を取得する

  Parameters

  • options: GetTweetOptions

    ツイート取得オプション

  Returns Promise<CustomTweetObject>

  ツイートの生情報

getRawUserByUserId

• getRawUserByUserId(
      options: GetUserByUserIdOptions,
  ): Promise<GraphQLGetUserByScreenNameSuccessResponse>

  ユーザー ID からユーザー情報を取得する。ユーザー情報は生レスポンスで返す

  Parameters

  • options: GetUserByUserIdOptions

  Returns Promise<GraphQLGetUserByScreenNameSuccessResponse>

  ユーザー情報（生レスポンス）

getScreenNameByUserId

• getScreenNameByUserId(options: GetScreenNameByUserIdOptions): Promise<string>

  ユーザー ID からスクリーンネームを取得する

  Parameters

  • options: GetScreenNameByUserIdOptions

  Returns Promise<string>

  スクリーンネーム

getTweet

• getTweet(options: GetTweetOptions): Promise<Status>

  ツイートの情報を取得する

  Parameters

  • options: GetTweetOptions

    ツイート取得オプション

  Returns Promise<Status>

  ツイート

getUserByScreenName

• getUserByScreenName(
      options: GetUserByScreenNameOptions,
  ): Promise<GraphQLGetUserByScreenNameSuccessResponse>

  スクリーンネームからユーザー情報を取得する

  Parameters

  • options: GetUserByScreenNameOptions

    ユーザー情報取得オプション

  Returns Promise<GraphQLGetUserByScreenNameSuccessResponse>

  ユーザー情報

getUserByUserId

• getUserByUserId(options: GetUserByUserIdOptions): Promise<FullUser>

  ユーザー ID からスクリーンネームを取得する

  Parameters

  • options: GetUserByUserIdOptions

  Returns Promise<FullUser>

  スクリーンネーム

getUserTweets

• getUserTweets(options: GetUserTweetsOptions): Promise<Status[]>

  ユーザーのツイートを取得する

  Parameters

  • options: GetUserTweetsOptions

    ユーザーツイート取得オプション

  Returns Promise<Status[]>

  ユーザーのツイート

isErrorResponse

• isErrorResponse(response: any): response is { errors: any[] }

  エラーレスポンスかどうかを判定する。 これを使うことでエラーがどうかは判定できるが、レスポンス型は保証されないので利用側で型保証されるメソッドを書いたほうがよい。

  Parameters

  • response: any

    レスポンス

  Returns response is { errors: any[] }

  エラーレスポンスかどうか

likeTweet

• likeTweet(options: LikeTweetOptions): Promise<undefined | string>

  ツイートをいいねする

  Parameters

  • options: LikeTweetOptions

    いいねオプション

  Returns Promise<undefined | string>

  いいねできたかどうかの文字列（Done）

searchRawTweets

• searchRawTweets(options: SearchTweetsOptions): Promise<CustomTweetObject[]>

  ツイートを検索する。ツイートは非正規化ツイート（CustomTweetObject）で返す

  Parameters

  • options: SearchTweetsOptions

    検索オプション

  Returns Promise<CustomTweetObject[]>

  検索結果（非正規化ツイート）

searchTweets

• searchTweets(options: SearchTweetsOptions): Promise<Status[]>

  ツイートを検索する。

  Parameters

  • options: SearchTweetsOptions

    検索オプション

  Returns Promise<Status[]>

  検索結果

unblockUser

• unblockUser(options: UnblockUserOptions): Promise<void>

  ユーザーのブロックを解除する

  Parameters

  • options: UnblockUserOptions

    ブロック解除オプション

  Returns Promise<void>

unlikeTweet

• unlikeTweet(options: UnlikeTweetOptions): Promise<undefined | string>

  ツイートのいいねを解除する

  Parameters

  • options: UnlikeTweetOptions

    いいね解除オプション

  Returns Promise<undefined | string>

  いいね解除できたかどうかの文字列（Done）

Staticlogin

• login(options: TwitterScraperOptions): Promise<Twitter>

  Twitter にログインする

  Parameters

  • options: TwitterScraperOptions

    ログインオプション

  Returns Promise<Twitter>

  Twitter インスタンス