narou
    Preparing search index...

    Class RankingBuilder

    なろう小説ランキングAPIのヘルパークラス。

    ランキング種別や日付を指定してランキングデータを取得します。 また、取得したランキングデータに含まれるNコードを元に、 なろう小説APIを利用して詳細な小説情報を取得することも可能です。

    RankingBuilder

    https://dev.syosetu.com/man/rankapi/ なろう小説ランキングAPI仕様

    Index

    Properties

    api date$ params type$

    Methods

    date execute executeWithFields gzip type

    Properties

    api: NarouNovel

    API実行クラスのインスタンス

    date$: Date

    ランキング集計対象の日付

    params: Partial<RankingParams> = {}

    初期クエリパラメータ

    type$: RankingType

    ランキング種別

    Methods

    • ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。

      Returns Promise<
          RankingResult<
              | "length"
              | "time"
              | "end"
              | "title"
              | "keyword"
              | "biggenre"
              | "genre"
              | "userid"
              | "isr15"
              | "isbl"
              | "isgl"
              | "iszankoku"
              | "istensei"
              | "istenni"
              | "kaiwaritu"
              | "ncode"
              | "novel_type"
              | "writer"
              | "story"
              | "general_firstup"
              | "general_lastup"
              | "general_all_no"
              | "isstop"
              | "global_point"
              | "daily_point"
              | "weekly_point"
              | "monthly_point"
              | "quarter_point"
              | "yearly_point"
              | "fav_novel_cnt"
              | "impression_cnt"
              | "review_cnt"
              | "all_point"
              | "all_hyoka_cnt"
              | "sasie_cnt"
              | "novelupdated_at"
              | "updated_at",
          >[],
      >

    • ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。

      Type Parameters

      • TFields extends Fields

        取得する小説情報のフィールド型

      Parameters

      Returns Promise<RankingResult<SearchResultFields<TFields>>[]>

      詳細情報を含むランキング結果の配列

    • ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。

      Parameters

      • fields: never[]
      • opt: "weekly" | "weekly"[]

        オプショナルな取得フィールド (weekly など)

      Returns Promise<
          RankingResult<
              | "length"
              | "time"
              | "end"
              | "title"
              | "keyword"
              | "biggenre"
              | "genre"
              | "userid"
              | "isr15"
              | "isbl"
              | "isgl"
              | "iszankoku"
              | "istensei"
              | "istenni"
              | "kaiwaritu"
              | "ncode"
              | "weekly_unique"
              | "novel_type"
              | "writer"
              | "story"
              | "general_firstup"
              | "general_lastup"
              | "general_all_no"
              | "isstop"
              | "global_point"
              | "daily_point"
              | "weekly_point"
              | "monthly_point"
              | "quarter_point"
              | "yearly_point"
              | "fav_novel_cnt"
              | "impression_cnt"
              | "review_cnt"
              | "all_point"
              | "all_hyoka_cnt"
              | "sasie_cnt"
              | "novelupdated_at"
              | "updated_at",
          >[],
      >

      詳細情報を含むランキング結果の配列

    • ランキングAPIを実行し、取得したNコードを元になろう小説APIで詳細情報を取得して結合します。

      Type Parameters

      • TFields extends Fields

        取得する小説情報のフィールド型

      Parameters

      • fields: TFields | TFields[]

        取得するフィールドの配列

      • opt: "weekly" | "weekly"[]

        オプショナルな取得フィールド (weekly など)

      Returns Promise<RankingResult<"weekly_unique" | SearchResultFields<TFields>>[]>

      詳細情報を含むランキング結果の配列

    Settings

    Member Visibility

    On This Page

    Properties
    Methods