Class SearchBuilderBase<TParams, TOrder>`Abstract`

Type Parameters

TParams extends ParamsBaseWithOrder<TOrder>
TOrder extends string

Hierarchy (View Summary)

SearchBuilderBase
- NovelSearchBuilderBase

Index

Properties

Methods

gzip limit order page set start unset array2string distinct

Properties

`Protected`api

api: NarouNovel

NarouNovel インスタンス

`Protected`params

params: TParams = ...

クエリパラメータ

Methods

gzip

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

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

limit

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

order

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

page

page(no: number, count?: number): this
ページ番号と1ページあたりの件数で取得範囲を指定する
Parameters
- no: number
  ページ番号 (0-)
- count: number = 20
  1ページあたりの件数 (デフォルト: 20)
Returns this
- Defined in work/node-narou/node-narou/src/search-builder.ts:99

`Protected`set

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

start

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

`Protected`unset

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

`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
- 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
- Defined in work/node-narou/node-narou/src/search-builder.ts:52