narou/dist/search-builder-r18.d.cts

Narou API Wrapper

import { d as NovelSearchBuilderBase } from './narou-DCp4aGfA.cjs';
import { d as SearchResultFieldNames, r as NarouSearchResult, N as NarouSearchResults, h as R18Site, e as R18Fields, w as SearchResultR18Fields, O as OptionalFields, v as SearchResultOptionalFields } from './narou-search-results-C21hWrnL.cjs';
import './ranking-history.cjs';
import './util/type.cjs';

type DefaultR18SearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "biggenre" | "genre" | "isr15" | "id">;
/**
 * 18禁API検索ヘルパー
 * @class SearchBuilderR18
 */
declare class SearchBuilderR18<T extends SearchResultFieldNames = DefaultR18SearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
    /**
     * なろう小説APIへの検索リクエストを実行する
     * @override
     * @returns {Promise<NarouSearchResults>} 検索結果
     */
    execute(): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>>;
    /**
     * 抽出するR18サイトを指定します (nocgenre)。
     * @param sites R18サイトコード、またはR18サイトコードの配列 (1: ノクターンノベルズ, 2: ムーンライトノベルズ(男性向け), 3: ムーンライトノベルズ(BL), 4: ミッドナイトノベルズ)
     * @return {this}
     */
    r18Site(sites: R18Site | readonly R18Site[]): this;
    /**
     * X-IDを指定して取得します (xid)。
     * @param ids X-ID、またはX-IDの配列
     * @return {this}
     */
    xid(ids: number | readonly number[]): this;
    /**
     * 出力する項目を個別に指定します (of)。
     * 未指定時は全項目出力されます。転送量軽減のため、このパラメータの使用が推奨されます。
     * @param fields 出力するR18フィールド名、またはR18フィールド名の配列
     * @return {SearchBuilderR18<SearchResultR18Fields<R18Fields>>} 型が更新されたビルダー
     */
    fields<TFields extends R18Fields>(fields: TFields | readonly TFields[]): SearchBuilderR18<SearchResultR18Fields<R18Fields>>;
    /**
     * 出力オプション項目を指定します (opt)。
     * @param option 出力するオプションフィールド名、またはオプションフィールド名の配列
     * @return {SearchBuilderR18<T, SearchResultOptionalFields<TFields>>} 型が更新されたビルダー
     */
    opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilderR18<T, SearchResultOptionalFields<TFields>>;
}

export { type DefaultR18SearchResultFields, SearchBuilderR18 as default };