Class SearchBuilder<T, TOpt>

検索ヘルパー SearchBuilder

Type Parameters

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

Hierarchy (View Summary)

NovelSearchBuilderBase<T | TOpt>
- SearchBuilder

Properties

`Protected`api

api: NarouNovel

`Protected`params

params: SearchParams = ...

Methods

bigGenre

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

buntai

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

byAuthor

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

byKeyword

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

byOutline

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

byTitle

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

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:394

fields

fields<TFields extends Fields>(
fields: TFields | readonly TFields[],
): 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:469

genre

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

gzip

gzip(level: GzipLevel): 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:101

isBL

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

isGL

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

isPickup

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

isR15

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

isStop

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

isTenni

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

isTensei

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

isTT

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

isZankoku

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

kaiwaritu

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

lastNovelUpdate

lastNovelUpdate(date: string): this
Parameters
- date: string
Returns this
Inherited from NovelSearchBuilderBase.lastNovelUpdate
- Defined in work/node-narou/node-narou/src/search-builder.ts:370
lastNovelUpdate(from: number, to: number): this
Parameters
- from: number
- to: number
Returns this
Inherited from NovelSearchBuilderBase.lastNovelUpdate
- Defined in work/node-narou/node-narou/src/search-builder.ts:371
lastNovelUpdate(from: Date, to: Date): this
Parameters
- from: Date
- to: Date
Returns this
Inherited from NovelSearchBuilderBase.lastNovelUpdate
- Defined in work/node-narou/node-narou/src/search-builder.ts:372

lastUpdate

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

length

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

limit

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

ncode

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

notBigGenre

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

notGenre

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

notWord

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

opt

opt<TFields extends "weekly">(
option: TFields | readonly TFields[],
): 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:477

order

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:89

sasie

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

start

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

time

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

type

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

`Protected`unset

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

userId

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

word

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

`Protected` `Static`array2string

array2string<T extends string | number>(n: T | readonly T[]): 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:47

`Protected` `Static`distinct

distinct<T>(array: readonly T[]): 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:43

Class SearchBuilder<T, TOpt>

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Protectedapi

Protectedparams

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

isTenni

Parameters

Returns this

isTensei

Parameters

Returns this

isTT

Returns this

isZankoku

Parameters

Returns this

kaiwaritu

Parameters

Returns this

Parameters

Returns this

lastNovelUpdate

Parameters

Returns this

Parameters

Returns this

Parameters

Returns this

lastUpdate

Parameters

`Protected`api

`Protected`params

`Protected`unset

`Protected` `Static`array2string

`Protected` `Static`distinct