Class Pixiv

ReadonlyaccessToken

Readonlyaxios

ReadonlyrefreshToken

ReadonlyresponseDatabase

ReadonlyuserId

close

• close(): Promise<void>

  接続を閉じる。

  Returns Promise<void>

illustBookmarkAdd

• illustBookmarkAdd(
      options: IllustBookmarkAddOptions,
  ): Promise<AxiosResponse<PostV2IllustBookmarkAddResponse, any>>

  イラストをブックマークする。

  Parameters

  • options: IllustBookmarkAddOptions

    オプション

  Returns Promise<AxiosResponse<PostV2IllustBookmarkAddResponse, any>>

  レスポンス

illustBookmarkDelete

• illustBookmarkDelete(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<PostV1IllustBookmarkDeleteResponse, any>>

  イラストのブックマークを削除する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<PostV1IllustBookmarkDeleteResponse, any>>

  レスポンス

illustDetail

• illustDetail(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1IllustDetailResponse, any>>

  イラストの詳細情報を取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<GetV1IllustDetailResponse, any>>

  レスポンス

illustRanking

• illustRanking(
      options?: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1IllustRankingResponse, any>>

  イラストランキングを取得する。

  Parameters

  • options: SnakeToCamel = {}

    オプション

  Returns Promise<AxiosResponse<GetV1IllustRankingResponse, any>>

  レスポンス

illustRecommended

• illustRecommended(
      options?: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1IllustRecommendedResponse, any>>

  おすすめイラストを取得する。

  Parameters

  • options: SnakeToCamel = {}

    オプション

  Returns Promise<AxiosResponse<GetV1IllustRecommendedResponse, any>>

  レスポンス

illustRelated

• illustRelated(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<GetV2IllustRelatedResponse, any>>

  イラストの関連イラストを取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<GetV2IllustRelatedResponse, any>>

  レスポンス

illustSeries

• illustSeries(
      options: IllustSeriesOptions,
  ): Promise<AxiosResponse<GetV1IllustSeriesResponse, any>>

  イラストシリーズの詳細情報を取得する。

  Parameters

  • options: IllustSeriesOptions

    オプション

  Returns Promise<AxiosResponse<GetV1IllustSeriesResponse, any>>

  レスポンス

mangaRecommended

• mangaRecommended(
      options?: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1MangaRecommendedResponse, any>>

  Parameters

  • options: SnakeToCamel = {}

  Returns Promise<AxiosResponse<GetV1MangaRecommendedResponse, any>>

novelBookmarkAdd

• novelBookmarkAdd(
      options: NovelBookmarkAddOptions,
  ): Promise<AxiosResponse<PostV2NovelBookmarkAddResponse, any>>

  小説をブックマークする。

  Parameters

  • options: NovelBookmarkAddOptions

    オプション

  Returns Promise<AxiosResponse<PostV2NovelBookmarkAddResponse, any>>

  レスポンス

novelBookmarkDelete

• novelBookmarkDelete(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<PostV1NovelBookmarkDeleteResponse, any>>

  小説のブックマークを削除する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<PostV1NovelBookmarkDeleteResponse, any>>

  レスポンス

novelDetail

• novelDetail(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<GetV2NovelDetailResponse, any>>

  小説の詳細情報を取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<GetV2NovelDetailResponse, any>>

  レスポンス

novelRanking

• novelRanking(
      options?: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1NovelRankingResponse, any>>

  小説ランキングを取得する。

  Parameters

  • options: SnakeToCamel = {}

  Returns Promise<AxiosResponse<GetV1NovelRankingResponse, any>>

novelRecommended

• novelRecommended(
      options?: RecommendedNovelOptions,
  ): Promise<AxiosResponse<GetV1NovelRecommendedResponse, any>>

  おすすめ小説を取得する。

  Parameters

  • options: RecommendedNovelOptions = {}

    オプション

  Returns Promise<AxiosResponse<GetV1NovelRecommendedResponse, any>>

  レスポンス

novelRelated

• novelRelated(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1NovelRelatedResponse, any>>

  小説の関連小説を取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<GetV1NovelRelatedResponse, any>>

  レスポンス

novelSeries

• novelSeries(
      options: NovelSeriesOptions,
  ): Promise<AxiosResponse<GetV2NovelSeriesResponse, any>>

  小説シリーズの詳細情報を取得する。

  Parameters

  • options: NovelSeriesOptions

    オプション

  Returns Promise<AxiosResponse<GetV2NovelSeriesResponse, any>>

  レスポンス

novelText

• novelText(options: SnakeToCamel): Promise<AxiosResponse<string, any>>

  小説の本文を取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<string, any>>

  レスポンス

searchIllust

• searchIllust(
      options: SearchIllustOptions,
  ): Promise<AxiosResponse<GetV1SearchIllustResponse, any>>

  イラストを検索する。

  Parameters

  • options: SearchIllustOptions

    オプション

  Returns Promise<AxiosResponse<GetV1SearchIllustResponse, any>>

  レスポンス

searchNovel

• searchNovel(
      options: SearchNovelOptions,
  ): Promise<AxiosResponse<GetV1SearchNovelResponse, any>>

  小説を検索する。

  Parameters

  • options: SearchNovelOptions

    オプション

  Returns Promise<AxiosResponse<GetV1SearchNovelResponse, any>>

  レスポンス

ugoiraMetadata

• ugoiraMetadata(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1IllustUgoiraMetadataResponse, any>>

  うごイラの詳細情報を取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<GetV1IllustUgoiraMetadataResponse, any>>

  レスポンス

userBookmarksIllust

• userBookmarksIllust(
      options: UserBookmarksIllustOptions,
  ): Promise<AxiosResponse<GetV1UserBookmarksIllustResponse, any>>

  ユーザのイラストブックマークを取得する。

  Parameters

  • options: UserBookmarksIllustOptions

    オプション

  Returns Promise<AxiosResponse<GetV1UserBookmarksIllustResponse, any>>

  レスポンス

userBookmarksNovel

• userBookmarksNovel(
      options: UserBookmarksNovelOptions,
  ): Promise<AxiosResponse<GetV1UserBookmarksNovelResponse, any>>

  ユーザの小説ブックマークを取得する。

  Parameters

  • options: UserBookmarksNovelOptions

    オプション

  Returns Promise<AxiosResponse<GetV1UserBookmarksNovelResponse, any>>

  レスポンス

userDetail

• userDetail(
      options: SnakeToCamel,
  ): Promise<AxiosResponse<GetV1UserDetailResponse, any>>

  ユーザの詳細情報を取得する。

  Parameters

  • options: SnakeToCamel

    オプション

  Returns Promise<AxiosResponse<GetV1UserDetailResponse, any>>

  レスポンス

StaticgetAxiosImageStream

• getAxiosImageStream(url: string): Promise<AxiosResponse<ReadStream, any>>

  画像のaxiosストリームを取得する。

  Parameters

  • url: string

  Returns Promise<AxiosResponse<ReadStream, any>>

StaticisError

• isError(response: any): response is PixivApiError

  レスポンスがエラーかどうかを判定する。

  Parameters

  • response: any

    Axios レスポンス

  Returns response is PixivApiError

  エラーかどうか

Staticof

• of(refreshToken: string, pixivTsOptions?: PixivTsOptions): Promise<Pixiv>

  リフレッシュトークンからインスタンスを生成する。

  Parameters

  • refreshToken: string

    リフレッシュトークン
  • OptionalpixivTsOptions: PixivTsOptions

  Returns Promise<Pixiv>

  Pixiv インスタンス

StaticparseQueryString

• parseQueryString(url: string): ParsedQs

  クエリストリングをパースする。

  Parameters

  • url: string

    URL

  Returns ParsedQs

  パースしたクエリストリングオブジェクト