Class QueryBuilder

A class used to easily build a query string for the API.

Hierarchy

QueryBuilder

Index

Methods

Methods

build

build(): string

- Defined in queryBuilder.ts:57
Assembles the query into a url with all the parameters set.

Returns string
The search url with all the query parameters set.

maxPrice

maxPrice(maxPrice: MaxPrice): QueryBuilder

- Defined in queryBuilder.ts:48
Sets the maximum price of the query.

Parameters
- maxPrice: MaxPrice
  
  The maximum price.
Returns QueryBuilder

search

search(term: string): QueryBuilder

- Defined in queryBuilder.ts:30
Sets the search term of the query.

Parameters
- term: string
  
  The search term.
Returns QueryBuilder

sortBy

sortBy(sort: SortBy): QueryBuilder

- Defined in queryBuilder.ts:39
Sets the sort order of the query.

Parameters
- sort: SortBy
  
  The sort order.
Returns QueryBuilder

toString

toString(): string

- Defined in queryBuilder.ts:65
Assembles the query into a url with all the parameters set.

Returns string
The search url with all the query parameters set.

Static create

create(term: undefined | string): QueryBuilder

- Defined in queryBuilder.ts:22
Creates a new QueryBuilder instance.

Parameters
- term: undefined | string
  
  The search term.
Returns QueryBuilder

Generated using TypeDoc, the 3/6/2022