Class Pixiv

ReadonlyaccessToken

Readonlyhttp

ReadonlyrefreshToken

ReadonlyresponseDatabase

ReadonlyuserId

close

• close(): Promise<void>

  接続を閉じる。

  Returns Promise<void>

illustBookmarkAdd

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

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

  Parameters

  • options: IllustBookmarkAddOptions

    オプション

  Returns Promise<PixivApiResponse<PostV2IllustBookmarkAddResponse>>

  レスポンス

illustBookmarkDelete

• illustBookmarkDelete(
      options: IllustBookmarkDeleteOptions,
  ): Promise<PixivApiResponse<PostV1IllustBookmarkDeleteResponse>>

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

  Parameters

  • options: IllustBookmarkDeleteOptions

    オプション

  Returns Promise<PixivApiResponse<PostV1IllustBookmarkDeleteResponse>>

  レスポンス

illustDetail

• illustDetail(
      options: IllustDetailOptions,
  ): Promise<PixivApiResponse<GetV1IllustDetailResponse>>

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

  Parameters

  • options: IllustDetailOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1IllustDetailResponse>>

  レスポンス

illustRanking

• illustRanking(
      options?: IllustRankingOptions,
  ): Promise<PixivApiResponse<GetV1IllustRankingResponse>>

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

  Parameters

  • options: IllustRankingOptions = {}

    オプション

  Returns Promise<PixivApiResponse<GetV1IllustRankingResponse>>

  レスポンス

illustRecommended

• illustRecommended(
      options?: RecommendedIllustOptions,
  ): Promise<PixivApiResponse<GetV1IllustRecommendedResponse>>

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

  Parameters

  • options: RecommendedIllustOptions = {}

    オプション

  Returns Promise<PixivApiResponse<GetV1IllustRecommendedResponse>>

  レスポンス

illustRelated

• illustRelated(
      options: IllustRelatedOptions,
  ): Promise<PixivApiResponse<GetV2IllustRelatedResponse>>

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

  Parameters

  • options: IllustRelatedOptions

    オプション

  Returns Promise<PixivApiResponse<GetV2IllustRelatedResponse>>

  レスポンス

illustSeries

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

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

  Parameters

  • options: IllustSeriesOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1IllustSeriesResponse>>

  レスポンス

mangaRecommended

• mangaRecommended(
      options?: MangaRecommendedOptions,
  ): Promise<PixivApiResponse<GetV1MangaRecommendedResponse>>

  Parameters

  • options: MangaRecommendedOptions = {}

  Returns Promise<PixivApiResponse<GetV1MangaRecommendedResponse>>

novelBookmarkAdd

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

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

  Parameters

  • options: NovelBookmarkAddOptions

    オプション

  Returns Promise<PixivApiResponse<PostV2NovelBookmarkAddResponse>>

  レスポンス

novelBookmarkDelete

• novelBookmarkDelete(
      options: NovelBookmarkDeleteOptions,
  ): Promise<PixivApiResponse<PostV1NovelBookmarkDeleteResponse>>

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

  Parameters

  • options: NovelBookmarkDeleteOptions

    オプション

  Returns Promise<PixivApiResponse<PostV1NovelBookmarkDeleteResponse>>

  レスポンス

novelDetail

• novelDetail(
      options: NovelDetailOptions,
  ): Promise<PixivApiResponse<GetV2NovelDetailResponse>>

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

  Parameters

  • options: NovelDetailOptions

    オプション

  Returns Promise<PixivApiResponse<GetV2NovelDetailResponse>>

  レスポンス

novelRanking

• novelRanking(
      options?: NovelRankingOptions,
  ): Promise<PixivApiResponse<GetV1NovelRankingResponse>>

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

  Parameters

  • options: NovelRankingOptions = {}

  Returns Promise<PixivApiResponse<GetV1NovelRankingResponse>>

novelRecommended

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

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

  Parameters

  • options: RecommendedNovelOptions = {}

    オプション

  Returns Promise<PixivApiResponse<GetV1NovelRecommendedResponse>>

  レスポンス

novelRelated

• novelRelated(
      options: NovelRelatedOptions,
  ): Promise<PixivApiResponse<GetV1NovelRelatedResponse>>

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

  Parameters

  • options: NovelRelatedOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1NovelRelatedResponse>>

  レスポンス

novelSeries

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

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

  Parameters

  • options: NovelSeriesOptions

    オプション

  Returns Promise<PixivApiResponse<GetV2NovelSeriesResponse>>

  レスポンス

novelText

• novelText(options: NovelTextOptions): Promise<PixivApiResponse<string>>

  小説の本文を取得する。

  Parameters

  • options: NovelTextOptions

    オプション

  Returns Promise<PixivApiResponse<string>>

  レスポンス

searchIllust

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

  イラストを検索する。

  Parameters

  • options: SearchIllustOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1SearchIllustResponse>>

  レスポンス

searchNovel

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

  小説を検索する。

  Parameters

  • options: SearchNovelOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1SearchNovelResponse>>

  レスポンス

ugoiraMetadata

• ugoiraMetadata(
      options: UgoiraDetailOptions,
  ): Promise<PixivApiResponse<GetV1IllustUgoiraMetadataResponse>>

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

  Parameters

  • options: UgoiraDetailOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1IllustUgoiraMetadataResponse>>

  レスポンス

userBookmarksIllust

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

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

  Parameters

  • options: UserBookmarksIllustOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1UserBookmarksIllustResponse>>

  レスポンス

userBookmarksNovel

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

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

  Parameters

  • options: UserBookmarksNovelOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1UserBookmarksNovelResponse>>

  レスポンス

userDetail

• userDetail(
      options: UserDetailOptions,
  ): Promise<PixivApiResponse<GetV1UserDetailResponse>>

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

  Parameters

  • options: UserDetailOptions

    オプション

  Returns Promise<PixivApiResponse<GetV1UserDetailResponse>>

  レスポンス

StaticgetImageStream

• getImageStream(url: string): Promise<Response>

  画像取得用の Response を返す。

  戻り値はストリームそのものではなく Response オブジェクトであり、 ストリームとして読み取る場合は response.body を参照する。 必要に応じて arrayBuffer() などの Response の API も利用できる。

  Parameters

  • url: string

    画像 URL

  Returns Promise<Response>

  画像取得結果の Response

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

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