Class NovelSearchBuilderBase<T>`Abstract`

Type Parameters

T extends SearchResultFieldNames

Hierarchy (View Summary)

SearchBuilderBase<SearchParams, Order>
- NovelSearchBuilderBase
  - SearchBuilder
  - SearchBuilderR18

Index

Properties

`Protected`api

api: NarouNovel

NarouNovel インスタンス

`Protected`params

params: SearchParams = ...

クエリパラメータ

Methods

buntai

buntai(buntai: BuntaiParam | readonly BuntaiParam[]): this
抽出する作品の文体を指定します (buntai)。複数指定する場合はハイフン(-)で区切ってください。
Parameters
- buntai: BuntaiParam | readonly BuntaiParam[]
  文体コード、または文体コードの配列
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:375

byAuthor

byAuthor(bool?: boolean): this
検索対象を作者名に限定するかどうかを指定します (wname)。
Parameters
- bool: boolean = true
  trueの場合、作者名を検索対象とする (デフォルト: true)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:209

byKeyword

byKeyword(bool?: boolean): this
検索対象をキーワードに限定するかどうかを指定します (keyword)。
Parameters
- bool: boolean = true
  trueの場合、キーワードを検索対象とする (デフォルト: true)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:199

byOutline

byOutline(bool?: boolean): this
検索対象をあらすじに限定するかどうかを指定します (ex)。
Parameters
- bool: boolean = true
  trueの場合、あらすじを検索対象とする (デフォルト: true)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:189

byTitle

byTitle(bool?: boolean): this
検索対象を作品名に限定するかどうかを指定します (title)。
Parameters
- bool: boolean = true
  trueの場合、作品名を検索対象とする (デフォルト: true)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:179

execute

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

Returns Promise<NarouSearchResults<NarouSearchResult, T>>
検索結果
- Defined in work/node-narou/node-narou/src/search-builder.ts:477

gzip

gzip(level: GzipLevel): this
gzip圧縮レベルを指定する (gzip)

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

isBL

isBL(bool?: boolean): this
ボーイズラブ作品を抽出または除外します (isbl/notbl)。
Parameters
- bool: boolean = true
  trueの場合、ボーイズラブ作品を抽出する (デフォルト: true)。falseの場合、除外する。
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:219

isGL

isGL(bool?: boolean): this
ガールズラブ作品を抽出または除外します (isgl/notgl)。
Parameters
- bool: boolean = true
  trueの場合、ガールズラブ作品を抽出する (デフォルト: true)。falseの場合、除外する。
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:233

isPickup

isPickup(): this
ピックアップ作品のみを取得します (ispickup)。

Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:394

isStop

isStop(bool?: boolean): this
連載停止中作品に関する指定をします (stop)。
Parameters
- bool: boolean = true
  trueの場合、長期連載停止中のみ取得する (デフォルト: true)。falseの場合、長期連載停止中を除外する。
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:385

isTenni

isTenni(bool?: boolean): this
異世界転移作品を抽出または除外します (istenni/nottenni)。
Parameters
- bool: boolean = true
  trueの場合、異世界転移作品を抽出する (デフォルト: true)。falseの場合、除外する。
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:275

isTensei

isTensei(bool?: boolean): this
異世界転生作品を抽出または除外します (istensei/nottensei)。
Parameters
- bool: boolean = true
  trueの場合、異世界転生作品を抽出する (デフォルト: true)。falseの場合、除外する。
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:261

isTT

isTT(): this
異世界転生または異世界転移作品を抽出します (istt)。

Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:288

isZankoku

isZankoku(bool?: boolean): this
残酷な描写あり作品を抽出または除外します (iszankoku/notzankoku)。
Parameters
- bool: boolean = true
  trueの場合、残酷な描写あり作品を抽出する (デフォルト: true)。falseの場合、除外する。
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:247

kaiwaritu

kaiwaritu(num: number): this
抽出する作品の会話率を%単位で指定します (kaiwaritu)。
Parameters
- num: number
  会話率(%)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:309
kaiwaritu(min: number, max: number): this
抽出する作品の会話率を%単位で範囲指定します (kaiwaritu)。
Parameters
- min: number
  最低会話率(%)
- max: number
  最高会話率(%)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:316

lastNovelUpdate

lastNovelUpdate(date: string): this
作品の更新日時を指定します (lastupdate)。
Parameters
- date: string
  作品の更新日時 (YYYYMMDDhhmmss形式またはUNIXタイムスタンプ)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:441
lastNovelUpdate(from: number, to: number): this
作品の更新日時の範囲を指定します (lastupdate)。
Parameters
- from: number
  開始日時 (UNIXタイムスタンプ)
- to: number
  終了日時 (UNIXタイムスタンプ)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:448
lastNovelUpdate(from: Date, to: Date): this
作品の更新日時の範囲を指定します (lastupdate)。
Parameters
- from: Date
  開始日時 (Dateオブジェクト)
- to: Date
  終了日時 (Dateオブジェクト)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:455

lastUpdate

lastUpdate(date: string): this
最終更新日時を指定します (lastup)。
Parameters
- date: string
  最終更新日時 (YYYYMMDDhhmmss形式またはUNIXタイムスタンプ)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:404
lastUpdate(from: number, to: number): this
最終更新日時の範囲を指定します (lastup)。
Parameters
- from: number
  開始日時 (UNIXタイムスタンプ)
- to: number
  終了日時 (UNIXタイムスタンプ)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:411
lastUpdate(from: Date, to: Date): this
最終更新日時の範囲を指定します (lastup)。
Parameters
- from: Date
  開始日時 (Dateオブジェクト)
- to: Date
  終了日時 (Dateオブジェクト)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:418

length

length(length: number | readonly number[]): this
抽出する作品の文字数を指定します (length)。範囲指定する場合は、最小文字数と最大文字数をハイフン(-)記号で区切ってください。
Parameters
- length: number | readonly number[]
  文字数、または[最小文字数, 最大文字数]
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:299

limit

limit(num: number): this
取得件数を指定する (lim)
Parameters
- num: number
  取得件数 (1-500)
Returns this
Inherited from SearchBuilderBase.limit
- Defined in work/node-narou/node-narou/src/search-builder.ts:78

ncode

ncode(ncodes: string | readonly string[]): this
Nコードを指定して取得します (ncode)。
Parameters
- ncodes: string | readonly string[]
  Nコード、またはNコードの配列
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:354

notWord

notWord(word: string): this
除外したい単語を指定します (notword)。スペースで区切ることにより除外する単語を増やせます。部分一致で除外されます。
Parameters
- word: string
  除外語
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:169

order

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

sasie

sasie(num: number | readonly number[]): this
抽出する作品の挿絵数を指定します (sasie)。
Parameters
- num: number | readonly number[]
  挿絵数、または[最小挿絵数, 最大挿絵数]
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:334

`Protected`set

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

start

start(num: number): this
取得開始位置を指定する (st)
Parameters
- num: number
  取得開始位置 (1-)
Returns this
Inherited from SearchBuilderBase.start
- Defined in work/node-narou/node-narou/src/search-builder.ts:88

time

time(num: number | readonly number[]): this
抽出する作品の予想読了時間を分単位で指定します (time)。
Parameters
- num: number | readonly number[]
  読了時間(分)、または[最小読了時間, 最大読了時間]
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:344

type

type(type: NovelTypeParam): this
抽出する小説タイプを指定します (type)。
Parameters
- type: NovelTypeParam
  小説タイプ (t: 短編, r: 連載中, er: 完結済連載小説, ter: 短編と完結済連載小説, re: 連載中と完結済連載小説)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:364

`Protected`unset

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

word

word(word: string): this
検索語を指定します (word)。半角または全角スペースで区切るとAND抽出になります。部分一致でHITします。
Parameters
- word: string
  検索語
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:158

`Protected` `Static`array2string

array2string<T extends string | number>(n: T | readonly T[]): Join<T>
Protected
配列をハイフン区切りの文字列に変換する
Type Parameters
- T extends string | number
Parameters
- n: T | readonly T[]
  文字列または数値の配列、あるいは単一の文字列または数値
Returns Join<T>
ハイフン区切りの文字列

Static
Inherited from SearchBuilderBase.array2string
- Defined in work/node-narou/node-narou/src/search-builder.ts:63

`Protected` `Static`distinct

distinct<T>(array: readonly T[]): T[]
Protected
配列から重複を除去する
Type Parameters
- T
Parameters
- array: readonly T[]
  配列
Returns T[]
重複を除去した配列

Static
Inherited from SearchBuilderBase.distinct
- Defined in work/node-narou/node-narou/src/search-builder.ts:52

Class NovelSearchBuilderBase<T>Abstract

Type Parameters

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Protectedapi

Protectedparams

Methods

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

gzip

Parameters

Returns this

isBL

Parameters

Returns this

isGL

Parameters

Returns this

isPickup

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

Returns this

Parameters

Returns this

Parameters

Returns this

length

Parameters

Returns this

limit

Parameters

Returns this

ncode

Parameters

Returns this

Class NovelSearchBuilderBase<T>`Abstract`

`Protected`api

`Protected`params

`Protected`set

`Protected`unset

`Protected` `Static`array2string

`Protected` `Static`distinct