narou 0.8.0 → 0.8.1

package/dist/search-builder.d.ts

@@ -1,220 +1,220 @@
-import NarouNovel from "./narou";
-import { NarouSearchResult, SearchResultFields, SearchResultOptionalFields } from "./narou-search-results";
-import NarouSearchResults from "./narou-search-results";
-import { BigGenre, SearchResultFieldNames, Genre, SearchParams, Fields, Order, BuntaiParam, NovelTypeParam, GzipLevel, OptionalFields, ParamsBaseWithOrder } from "./params";
-import { Join } from "./util/type";
-export declare type DefaultSearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "nocgenre" | "xid">;
-export declare abstract class SearchBuilderBase<TParams extends ParamsBaseWithOrder<TOrder>, TOrder extends string> {
-    protected params: TParams;
-    protected api: NarouNovel;
-    /**
-     * constructor
-     * @private
-     */
-    constructor(params: TParams, api: NarouNovel);
-    protected static distinct<T>(array: readonly T[]): T[];
-    protected static array2string<T extends string | number>(n: T | readonly T[]): Join<T>;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    limit(num: number): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    start(num: number): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    page(no: number, count?: number): this;
-    /**
-     * 出力順序を指定する。指定しない場合は新着順となります。
-     * old	古い順
-     * @param {TOrder} order 出力順序
-     * @return {SearchBuilder} this
-     */
-    order(order: TOrder): this;
-    /**
-     * gzip圧縮する。
-     *
-     * 転送量上限を減らすためにも推奨
-     * @param {GzipLevel} level gzip圧縮レベル(1～5)
-     * @return {SearchBuilder} this
-     */
-    gzip(level: GzipLevel): this;
-    /**
-     * クエリパラメータをセットする
-     * @private
-     * @return {SearchBuilder} this
-     */
-    protected set(obj: TParams): this;
-    /**
-     * クエリパラメータを削除する
-     */
-    protected unset(key: keyof TParams): this;
-}
-export declare abstract class NovelSearchBuilderBase<T extends SearchResultFieldNames> extends SearchBuilderBase<SearchParams, Order> {
-    /**
-     * a
-     * @return {SearchBuilder} this
-     */
-    word(word: string): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    notWord(word: string): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    byTitle(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    byOutline(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    byKeyword(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    byAuthor(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isBL(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isGL(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isZankoku(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isTensei(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isTenni(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isTT(): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    length(length: number | readonly number[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    kaiwaritu(num: number): this;
-    kaiwaritu(min: number, max: number): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    sasie(num: number | readonly number[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    time(num: number | readonly number[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    ncode(ncodes: string | readonly string[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    type(type: NovelTypeParam): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    buntai(buntai: BuntaiParam | readonly BuntaiParam[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isStop(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isPickup(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    lastUpdate(date: string): this;
-    lastUpdate(from: number, to: number): this;
-    lastUpdate(from: Date, to: Date): this;
-    /**
-     * なろう小説APIへの検索リクエストを実行する
-     * @returns {Promise<NarouSearchResults>} 検索結果
-     */
-    execute(): Promise<NarouSearchResults<NarouSearchResult, T>>;
-}
-/**
- * 検索ヘルパー
- * @class SearchBuilder
- */
-export default class SearchBuilder<T extends keyof NarouSearchResult = DefaultSearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    bigGenre(genre: BigGenre | readonly BigGenre[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    notBigGenre(genre: BigGenre | readonly BigGenre[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    genre(genre: Genre | readonly Genre[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    notGenre(genre: Genre | readonly Genre[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    userId(ids: number | readonly number[]): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    isR15(bool?: boolean): this;
-    /**
-     *
-     * @return {SearchBuilder} this
-     */
-    fields<TFields extends Fields>(fields: TFields | readonly TFields[]): SearchBuilder<SearchResultFields<TFields>, TOpt>;
-    opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilder<T, SearchResultOptionalFields<TFields>>;
-}
+import NarouNovel from "./narou";
+import { NarouSearchResult, SearchResultFields, SearchResultOptionalFields } from "./narou-search-results";
+import NarouSearchResults from "./narou-search-results";
+import { BigGenre, SearchResultFieldNames, Genre, SearchParams, Fields, Order, BuntaiParam, NovelTypeParam, GzipLevel, OptionalFields, ParamsBaseWithOrder } from "./params";
+import { Join } from "./util/type";
+export declare type DefaultSearchResultFields = keyof Omit<NarouSearchResult, "weekly_unique" | "noveltype" | "nocgenre" | "xid">;
+export declare abstract class SearchBuilderBase<TParams extends ParamsBaseWithOrder<TOrder>, TOrder extends string> {
+    protected params: TParams;
+    protected api: NarouNovel;
+    /**
+     * constructor
+     * @private
+     */
+    constructor(params: TParams, api: NarouNovel);
+    protected static distinct<T>(array: readonly T[]): T[];
+    protected static array2string<T extends string | number>(n: T | readonly T[]): Join<T>;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    limit(num: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    start(num: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    page(no: number, count?: number): this;
+    /**
+     * 出力順序を指定する。指定しない場合は新着順となります。
+     * old	古い順
+     * @param {TOrder} order 出力順序
+     * @return {SearchBuilder} this
+     */
+    order(order: TOrder): this;
+    /**
+     * gzip圧縮する。
+     *
+     * 転送量上限を減らすためにも推奨
+     * @param {GzipLevel} level gzip圧縮レベル(1～5)
+     * @return {SearchBuilder} this
+     */
+    gzip(level: GzipLevel): this;
+    /**
+     * クエリパラメータをセットする
+     * @private
+     * @return {SearchBuilder} this
+     */
+    protected set(obj: TParams): this;
+    /**
+     * クエリパラメータを削除する
+     */
+    protected unset(key: keyof TParams): this;
+}
+export declare abstract class NovelSearchBuilderBase<T extends SearchResultFieldNames> extends SearchBuilderBase<SearchParams, Order> {
+    /**
+     * a
+     * @return {SearchBuilder} this
+     */
+    word(word: string): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notWord(word: string): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byTitle(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byOutline(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byKeyword(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    byAuthor(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isBL(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isGL(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isZankoku(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTensei(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTenni(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isTT(): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    length(length: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    kaiwaritu(num: number): this;
+    kaiwaritu(min: number, max: number): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    sasie(num: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    time(num: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    ncode(ncodes: string | readonly string[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    type(type: NovelTypeParam): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    buntai(buntai: BuntaiParam | readonly BuntaiParam[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isStop(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isPickup(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    lastUpdate(date: string): this;
+    lastUpdate(from: number, to: number): this;
+    lastUpdate(from: Date, to: Date): this;
+    /**
+     * なろう小説APIへの検索リクエストを実行する
+     * @returns {Promise<NarouSearchResults>} 検索結果
+     */
+    execute(): Promise<NarouSearchResults<NarouSearchResult, T>>;
+}
+/**
+ * 検索ヘルパー
+ * @class SearchBuilder
+ */
+export default class SearchBuilder<T extends keyof NarouSearchResult = DefaultSearchResultFields, TOpt extends keyof NarouSearchResult = never> extends NovelSearchBuilderBase<T | TOpt> {
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    bigGenre(genre: BigGenre | readonly BigGenre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notBigGenre(genre: BigGenre | readonly BigGenre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    genre(genre: Genre | readonly Genre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    notGenre(genre: Genre | readonly Genre[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    userId(ids: number | readonly number[]): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    isR15(bool?: boolean): this;
+    /**
+     *
+     * @return {SearchBuilder} this
+     */
+    fields<TFields extends Fields>(fields: TFields | readonly TFields[]): SearchBuilder<SearchResultFields<TFields>, TOpt>;
+    opt<TFields extends OptionalFields>(option: TFields | readonly TFields[]): SearchBuilder<T, SearchResultOptionalFields<TFields>>;
+}
 //# sourceMappingURL=search-builder.d.ts.map