Class SearchBuilderBase<TParams, TOrder>`Abstract`

Type Parameters

TParams extends ParamsBaseWithOrder<TOrder>
TOrder extends string

Hierarchy (view full)

SearchBuilderBase
- NovelSearchBuilderBase

Index

Constructors

Properties

Methods

gzip limit order page set start unset array2string distinct

Constructors

`Private` constructor

new SearchBuilderBase<TParams, TOrder>(params?, api): SearchBuilderBase<TParams, TOrder>
Private
constructor
Type Parameters
- TParams extends ParamsBaseWithOrder<TOrder>
- TOrder extends string
Parameters
- params: TParams = ...
- api: NarouNovel
Returns SearchBuilderBase<TParams, TOrder>
- Defined in work/node-narou/node-narou/src/search-builder.ts:37

Properties

`Protected` api

api: NarouNovel

`Protected` params

params: TParams = ...

Methods

gzip

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

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

limit

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

order

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

page

page(no, count?): this
Parameters
- no: number
- count: number = 20
Returns this
this
- Defined in work/node-narou/node-narou/src/search-builder.ts:78

`Private` set

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

start

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

`Protected` unset

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

`Static` `Protected` array2string

array2string<T>(n): Join<T>
Type Parameters
- T extends string | number
Parameters
- n: T | readonly T[]
Returns Join<T>
- 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[]
- Defined in work/node-narou/node-narou/src/search-builder.ts:42

Generated using TypeDoc