Class SearchUrl

Hierarchy

SearchUrl

Index

Methods

Methods

Static decodeExpressQuery

decodeExpressQuery(query: ExpressQuery): SearchAPIParamsModel

- Defined in src/ItemSearch/SearchUrl.ts:106
Parameters
- query: ExpressQuery
Returns SearchAPIParamsModel

Static decodeSearch

decodeSearch(location: string): SearchAPIParamsModel

- Defined in src/ItemSearch/SearchUrl.ts:61
Parameters
- location: string
Returns SearchAPIParamsModel

Static encodeFilter

encodeFilter(filterType: FilterType, options: string[] | number[]): string

- Defined in src/ItemSearch/SearchUrl.ts:54
Parameters
- filterType: FilterType
- options: string[] | number[]
Returns string

Static encodeQuery

encodeQuery(search: SearchAPIParamsModel): string

- Defined in src/ItemSearch/SearchUrl.ts:22
Encode the search params object into a query string to be set in the url

static

Parameters
- search: SearchAPIParamsModel
  
  the search params object to be encoded
Returns string

Static Private getBoolQueryParam

getBoolQueryParam(query: ExpressQuery, param: FilterType): boolean | undefined

- Defined in src/ItemSearch/SearchUrl.ts:99
Parameters
- query: ExpressQuery
- param: FilterType
Returns boolean | undefined

Static Private getQueryParam

getQueryParam(query: ExpressQuery, param: FilterType): string[] | undefined

- Defined in src/ItemSearch/SearchUrl.ts:92
Parameters
- query: ExpressQuery
- param: FilterType
Returns string[] | undefined

Static optionFlag

optionFlag(options?: string[]): boolean | undefined

- Defined in src/ItemSearch/SearchUrl.ts:142
Parameters
- Optional options: string[]
Returns boolean | undefined

Generated using TypeDoc