convertToHubParams

Function

Converts the common request format of contentSearch to a format specific to the Hub V3 Search API

Parameters

Parameter Type Default Notes
request Required IContentSearchRequest

the IContentSearchRequest instance for searching

Returns

Property Type Notes
q string
access Optional string
agg Optional {
fields:
string
mode:
string
size:
number
}
bbox Optional string
collection Optional any
content Optional any
downloadable Optional string
filter Optional any
groupIds Optional string
hasApi Optional string
hubType Optional string
id Optional string
isPortal Optional string
location_name Optional string
owner Optional string
page Optional {
ago:
{
size:
number
start:
number
}
hub:
{
size:
number
start:
number
}
} | {
key:
string
}
region Optional string
sector Optional string
sort Optional string
source Optional string
tags Optional string
type Optional string

Function defined in search/src/content/helpers/convert-request-to-hub-params.ts:42