@book000/pixivts 0.51.2 → 0.51.3

package/dist/pixiv.d.ts

@@ -50,227 +50,227 @@ export default class Pixiv {
     readonly rateLimitRetryOptions: PixivRateLimitRetryOptions | null;
     readonly http: PixivHttpClient;
     /**
-     * コンストラクタ。外部からインスタンス化できないので、of メソッドを使うこと。
+     * Constructor. Cannot be instantiated externally; use the `of` method instead.
      *
-     * @param userId ユーザー ID
-     * @param accessToken アクセストークン
-     * @param refreshToken リフレッシュトークン
-     * @param responseDatabase レスポンス保存用データベース（使用しない場合は null）
-     * @param rateLimitRetryOptions 429エラー時のリトライ設定
+     * @param userId User ID
+     * @param accessToken Access token
+     * @param refreshToken Refresh token
+     * @param responseDatabase Database for saving responses (null if not used)
+     * @param rateLimitRetryOptions Retry settings for 429 errors
      */
     private constructor();
     /**
-     * リフレッシュトークンからインスタンスを生成する。
+     * Creates an instance from a refresh token.
      *
-     * @param refreshToken リフレッシュトークン
-     * @returns Pixiv インスタンス
+     * @param refreshToken Refresh token
+     * @returns Pixiv instance
      */
     static of(refreshToken: string, pixivTsOptions?: PixivTsOptions): Promise<Pixiv>;
     /**
-     * 画像取得用の `Response` を返す。
+     * Returns a `Response` for fetching an image.
      *
-     * 戻り値はストリームそのものではなく `Response` オブジェクトであり、
-     * ストリームとして読み取る場合は `response.body` を参照する。
-     * 必要に応じて `arrayBuffer()` などの `Response` の API も利用できる。
+     * The return value is a `Response` object, not the stream itself;
+     * to read it as a stream, refer to `response.body`.
+     * Other `Response` APIs such as `arrayBuffer()` can also be used as needed.
      *
-     * @param url 画像 URL
-     * @returns 画像取得結果の `Response`
+     * @param url Image URL
+     * @returns The `Response` from fetching the image
      */
     static getImageStream(url: string): Promise<Response>;
     /**
-     * イラストの詳細情報を取得する。
+     * Gets the details of an illust.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustDetail(options: IllustDetailOptions): Promise<PixivApiResponse<GetV1IllustDetailResponse>>;
     /**
-     * イラストの関連イラストを取得する。
+     * Gets illusts related to an illust.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustRelated(options: IllustRelatedOptions): Promise<PixivApiResponse<GetV2IllustRelatedResponse>>;
     /**
-     * イラストを検索する。
+     * Searches for illusts.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     searchIllust(options: SearchIllustOptions): Promise<PixivApiResponse<GetV1SearchIllustResponse>>;
     /**
-     * イラストランキングを取得する。
+     * Gets the illust ranking.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustRanking(options?: IllustRankingOptions): Promise<PixivApiResponse<GetV1IllustRankingResponse>>;
     /**
-     * おすすめイラストを取得する。
+     * Gets recommended illusts.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustRecommended(options?: RecommendedIllustOptions): Promise<PixivApiResponse<GetV1IllustRecommendedResponse>>;
     /**
-     * イラストシリーズの詳細情報を取得する。
+     * Gets the details of an illust series.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustSeries(options: IllustSeriesOptions): Promise<PixivApiResponse<GetV1IllustSeriesResponse>>;
     /**
-     * イラストをブックマークする。
+     * Bookmarks an illust.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustBookmarkAdd(options: IllustBookmarkAddOptions): Promise<PixivApiResponse<PostV2IllustBookmarkAddResponse>>;
     /**
-     * イラストのブックマークを削除する。
+     * Removes an illust bookmark.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     illustBookmarkDelete(options: IllustBookmarkDeleteOptions): Promise<PixivApiResponse<PostV1IllustBookmarkDeleteResponse>>;
     mangaRecommended(options?: MangaRecommendedOptions): Promise<PixivApiResponse<GetV1MangaRecommendedResponse>>;
     /**
-     * うごイラの詳細情報を取得する。
+     * Gets the details of an ugoira.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     ugoiraMetadata(options: UgoiraDetailOptions): Promise<PixivApiResponse<GetV1IllustUgoiraMetadataResponse>>;
     /**
-     * 小説の詳細情報を取得する。
+     * Gets the details of a novel.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelDetail(options: NovelDetailOptions): Promise<PixivApiResponse<GetV2NovelDetailResponse>>;
     /**
-     * 小説の本文を取得する。
+     * Gets the text of a novel.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelText(options: NovelTextOptions): Promise<PixivApiResponse<string>>;
     /**
-     * 小説の関連小説を取得する。
+     * Gets novels related to a novel.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelRelated(options: NovelRelatedOptions): Promise<PixivApiResponse<GetV1NovelRelatedResponse>>;
     /**
-     * 小説を検索する。
+     * Searches for novels.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     searchNovel(options: SearchNovelOptions): Promise<PixivApiResponse<GetV1SearchNovelResponse>>;
     /**
-     * 小説ランキングを取得する。
+     * Gets the novel ranking.
      */
     novelRanking(options?: NovelRankingOptions): Promise<PixivApiResponse<GetV1NovelRankingResponse>>;
     /**
-     * おすすめ小説を取得する。
+     * Gets recommended novels.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelRecommended(options?: RecommendedNovelOptions): Promise<PixivApiResponse<GetV1NovelRecommendedResponse>>;
     /**
-     * 小説シリーズの詳細情報を取得する。
+     * Gets the details of a novel series.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelSeries(options: NovelSeriesOptions): Promise<PixivApiResponse<GetV2NovelSeriesResponse>>;
     /**
-     * 小説をブックマークする。
+     * Bookmarks a novel.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelBookmarkAdd(options: NovelBookmarkAddOptions): Promise<PixivApiResponse<PostV2NovelBookmarkAddResponse>>;
     /**
-     * 小説のブックマークを削除する。
+     * Removes a novel bookmark.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     novelBookmarkDelete(options: NovelBookmarkDeleteOptions): Promise<PixivApiResponse<PostV1NovelBookmarkDeleteResponse>>;
     /**
-     * ユーザの詳細情報を取得する。
+     * Gets the details of a user.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     userDetail(options: UserDetailOptions): Promise<PixivApiResponse<GetV1UserDetailResponse>>;
     /**
-     * ユーザのイラストブックマークを取得する。
+     * Gets a user's illust bookmarks.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     userBookmarksIllust(options: UserBookmarksIllustOptions): Promise<PixivApiResponse<GetV1UserBookmarksIllustResponse>>;
     /**
-     * ユーザの小説ブックマークを取得する。
+     * Gets a user's novel bookmarks.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     userBookmarksNovel(options: UserBookmarksNovelOptions): Promise<PixivApiResponse<GetV1UserBookmarksNovelResponse>>;
     /**
-     * 接続を閉じる。
+     * Closes the connection.
      */
     close(): Promise<void>;
     /**
-     * クエリストリングをパースする。
+     * Parses a query string.
      *
      * @param url URL
-     * @returns パースしたクエリストリングオブジェクト
+     * @returns The parsed query string object
      */
     static parseQueryString(url: string): qs.ParsedQs;
     /**
-     * レスポンスがエラーかどうかを判定する。
+     * Determines whether the response is an error.
      *
-     * @param response Axios レスポンス
-     * @returns エラーかどうか
+     * @param response Axios response
+     * @returns Whether it is an error
      */
     static isError(response: any): response is PixivApiError;
     /**
-     * MD5ハッシュを生成する。
+     * Generates an MD5 hash.
      *
-     * @param str 文字列
-     * @returns ハッシュ
+     * @param str String
+     * @returns Hash
      */
     private static hash;
     /**
-     * リクエストを送信する。
+     * Sends a request.
      *
-     * ジェネリクスの順番は、T: リクエスト、U: レスポンス。
+     * The order of generics is T: request, U: response.
      *
-     * @param options オプション
-     * @returns レスポンス
+     * @param options Options
+     * @returns Response
      */
     private request;
     private saveResponse;
     private isJSON;
     /**
-     * 必須のオプションが含まれているかどうかをチェックする。
+     * Checks whether the required options are included.
      *
-     * @param options オプション
-     * @param required 必須のオプションキー
-     * @throws 必須のオプションが含まれていない場合
+     * @param options Options
+     * @param required Required option keys
+     * @throws If a required option is missing
      */
     private checkRequiredOptions;
     /**
-     * キャメルケースのオブジェクトキーをスネークケースなオブジェクトキーに変換する。
+     * Converts camelCase object keys to snake_case object keys.
      *
-     * @param object オブジェクト
-     * @returns 変換後のオブジェクト
+     * @param object Object
+     * @returns The converted object
      */
     private convertCamelToSnake;
 }