Class SearchBuilder<T, TOpt>

検索ヘルパー SearchBuilder

Type Parameters

T extends keyof NarouSearchResult = DefaultSearchResultFields
TOpt extends keyof NarouSearchResult = never

Hierarchy (view full)

NovelSearchBuilderBase<T | TOpt>
- SearchBuilder

Index

Constructors

constructor

Properties

api params

Constructors

`Private` constructor

new SearchBuilder<T, TOpt>(params?, api): SearchBuilder<T, TOpt>
Private
constructor
Type Parameters
- T extends keyof NarouSearchResult = "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"
- TOpt extends keyof NarouSearchResult = never
Parameters
- params: SearchParams = ...
- api: NarouNovel
Returns SearchBuilder<T, TOpt>
Inherited from NovelSearchBuilderBase.constructor
- Defined in work/node-narou/node-narou/src/search-builder.ts:37

Properties

`Protected` api

api: NarouNovel

`Protected` params

params: SearchParams = ...

Methods

bigGenre

bigGenre(genre): this
Parameters
- genre: BigGenre | readonly BigGenre[]
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:390

buntai

buntai(buntai): this
Parameters
- buntai: BuntaiParam | readonly BuntaiParam[]
Returns this
this
Inherited from NovelSearchBuilderBase.buntai
- Defined in work/node-narou/node-narou/src/search-builder.ts:322

byAuthor

byAuthor(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.byAuthor
- Defined in work/node-narou/node-narou/src/search-builder.ts:176

byKeyword

byKeyword(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.byKeyword
- Defined in work/node-narou/node-narou/src/search-builder.ts:167

byOutline

byOutline(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.byOutline
- Defined in work/node-narou/node-narou/src/search-builder.ts:158

byTitle

byTitle(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.byTitle
- Defined in work/node-narou/node-narou/src/search-builder.ts:149

execute

execute(): Promise<NarouSearchResults<NarouSearchResult, T | TOpt>>
なろう小説APIへの検索リクエストを実行する

Returns Promise<NarouSearchResults<NarouSearchResult, T | TOpt>>
検索結果
Inherited from NovelSearchBuilderBase.execute
- Defined in work/node-narou/node-narou/src/search-builder.ts:373

fields

fields<TFields>(fields): SearchBuilder<SearchResultFields<TFields>, TOpt>
Type Parameters
- TFields extends Fields
Parameters
- fields: TFields | readonly TFields[]
Returns SearchBuilder<SearchResultFields<TFields>, TOpt>
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:448

genre

genre(genre): this
Parameters
- genre: Genre | readonly Genre[]
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:408

gzip

gzip(level): this
gzip圧縮する。

転送量上限を減らすためにも推奨
Parameters
- level: GzipLevel
  gzip圧縮レベル(1～5)
Returns this
this
Inherited from NovelSearchBuilderBase.gzip
- Defined in work/node-narou/node-narou/src/search-builder.ts:100

isBL

isBL(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isBL
- Defined in work/node-narou/node-narou/src/search-builder.ts:185

isGL

isGL(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isGL
- Defined in work/node-narou/node-narou/src/search-builder.ts:198

isPickup

isPickup(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isPickup
- Defined in work/node-narou/node-narou/src/search-builder.ts:340

isR15

isR15(bool?): this
Parameters
- bool: boolean = true
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:435

isStop

isStop(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isStop
- Defined in work/node-narou/node-narou/src/search-builder.ts:331

isTT

isTT(): this
Returns this
this
Inherited from NovelSearchBuilderBase.isTT
- Defined in work/node-narou/node-narou/src/search-builder.ts:250

isTenni

isTenni(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isTenni
- Defined in work/node-narou/node-narou/src/search-builder.ts:237

isTensei

isTensei(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isTensei
- Defined in work/node-narou/node-narou/src/search-builder.ts:224

isZankoku

isZankoku(bool?): this
Parameters
- bool: boolean = true
Returns this
this
Inherited from NovelSearchBuilderBase.isZankoku
- Defined in work/node-narou/node-narou/src/search-builder.ts:211

kaiwaritu

kaiwaritu(num): this
Parameters
- num: number
Returns this
this
Inherited from NovelSearchBuilderBase.kaiwaritu
- Defined in work/node-narou/node-narou/src/search-builder.ts:268
kaiwaritu(min, max): this
Parameters
- min: number
- max: number
Returns this
Inherited from NovelSearchBuilderBase.kaiwaritu
- Defined in work/node-narou/node-narou/src/search-builder.ts:269

lastUpdate

lastUpdate(date): this
Parameters
- date: string
Returns this
this
Inherited from NovelSearchBuilderBase.lastUpdate
- Defined in work/node-narou/node-narou/src/search-builder.ts:349
lastUpdate(from, to): this
Parameters
- from: number
- to: number
Returns this
Inherited from NovelSearchBuilderBase.lastUpdate
- Defined in work/node-narou/node-narou/src/search-builder.ts:350
lastUpdate(from, to): this
Parameters
- from: Date
- to: Date
Returns this
Inherited from NovelSearchBuilderBase.lastUpdate
- Defined in work/node-narou/node-narou/src/search-builder.ts:351

length

length(length): this
Parameters
- length: number | readonly number[]
Returns this
this
Inherited from NovelSearchBuilderBase.length
- Defined in work/node-narou/node-narou/src/search-builder.ts:259

limit

limit(num): this
Parameters
- num: number
Returns this
this
Inherited from NovelSearchBuilderBase.limit
- Defined in work/node-narou/node-narou/src/search-builder.ts:60

ncode

ncode(ncodes): this
Parameters
- ncodes: string | readonly string[]
Returns this
this
Inherited from NovelSearchBuilderBase.ncode
- Defined in work/node-narou/node-narou/src/search-builder.ts:304

notBigGenre

notBigGenre(genre): this
Parameters
- genre: BigGenre | readonly BigGenre[]
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:399

notGenre

notGenre(genre): this
Parameters
- genre: Genre | readonly Genre[]
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:417

notWord

notWord(word): this
Parameters
- word: string
Returns this
this
Inherited from NovelSearchBuilderBase.notWord
- Defined in work/node-narou/node-narou/src/search-builder.ts:140

opt

opt<TFields>(option): SearchBuilder<T, SearchResultOptionalFields<TFields>>
Type Parameters
- TFields extends "weekly"
Parameters
- option: TFields | readonly TFields[]
Returns SearchBuilder<T, SearchResultOptionalFields<TFields>>
- Defined in work/node-narou/node-narou/src/search-builder.ts:456

order

order(order): this
出力順序を指定する。指定しない場合は新着順となります。 old 古い順
Parameters
- order: Order
  出力順序
Returns this
this
Inherited from NovelSearchBuilderBase.order
- Defined in work/node-narou/node-narou/src/search-builder.ts:88

sasie

sasie(num): this
Parameters
- num: number | readonly number[]
Returns this
this
Inherited from NovelSearchBuilderBase.sasie
- Defined in work/node-narou/node-narou/src/search-builder.ts:286

`Private` set

set(obj): this
Private
クエリパラメータをセットする
Parameters
- obj: SearchParams
Returns this
this
Inherited from NovelSearchBuilderBase.set
- Defined in work/node-narou/node-narou/src/search-builder.ts:110

start

start(num): this
Parameters
- num: number
Returns this
this
Inherited from NovelSearchBuilderBase.start
- Defined in work/node-narou/node-narou/src/search-builder.ts:69

time

time(num): this
Parameters
- num: number | readonly number[]
Returns this
this
Inherited from NovelSearchBuilderBase.time
- Defined in work/node-narou/node-narou/src/search-builder.ts:295

type

type(type): this
Parameters
- type: NovelTypeParam
Returns this
this
Inherited from NovelSearchBuilderBase.type
- Defined in work/node-narou/node-narou/src/search-builder.ts:313

`Protected` unset

unset(key): this
クエリパラメータを削除する
Parameters
- key: keyof SearchParams
Returns this
Inherited from NovelSearchBuilderBase.unset
- Defined in work/node-narou/node-narou/src/search-builder.ts:118

userId

userId(ids): this
Parameters
- ids: number | readonly number[]
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:426

word

word(word): this
a
Parameters
- word: string
Returns this
this
Inherited from NovelSearchBuilderBase.word
- Defined in work/node-narou/node-narou/src/search-builder.ts:131

`Static` `Protected` array2string

array2string<T>(n): Join<T>
Type Parameters
- T extends string | number
Parameters
- n: T | readonly T[]
Returns Join<T>
Inherited from NovelSearchBuilderBase.array2string
- Defined in work/node-narou/node-narou/src/search-builder.ts:46

`Static` `Protected` distinct

distinct<T>(array): T[]
Type Parameters
- T
Parameters
- array: readonly T[]
Returns T[]
Inherited from NovelSearchBuilderBase.distinct
- Defined in work/node-narou/node-narou/src/search-builder.ts:42

Class SearchBuilder<T, TOpt>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

Private constructor

Type Parameters

Parameters

Returns SearchBuilder<T, TOpt>

Properties

Protected api

Protected params

Methods

bigGenre

Parameters

Returns this

buntai

Parameters

Returns this

byAuthor

Parameters

Returns this

byKeyword

Parameters

Returns this

byOutline

Parameters

Returns this

byTitle

Parameters

Returns this

execute

Returns Promise<NarouSearchResults<NarouSearchResult, T | TOpt>>

fields

Type Parameters

Parameters

Returns SearchBuilder<SearchResultFields<TFields>, TOpt>

genre

Parameters

Returns this

gzip

Parameters

Returns this

isBL

Parameters

Returns this

isGL

Parameters

Returns this

isPickup

Parameters

Returns this

isR15

Parameters

Returns this

isStop

Parameters

Returns this

isTT

Returns this

isTenni

Parameters

Returns this

isTensei

Parameters

Returns this

isZankoku

Parameters

Returns this

kaiwaritu

Parameters

Returns this

Parameters

Returns this

lastUpdate

Parameters

Returns this

`Private` constructor

`Protected` api

`Protected` params

`Private` set

`Protected` unset

`Static` `Protected` array2string

`Static` `Protected` distinct