Home > @vue-storefront/magento-api > categorySearch
categorySearch() function
Searches for categories using received filters.
Signature:
export default function categorySearch(context: Context, filters: CategorySearchQueryVariables, customQuery?: CustomQuery, customHeaders?: CustomHeaders): Promise<ApolloQueryResult<CategorySearchQuery>>;
Parameters
Parameter | Type | Description |
---|---|---|
context | Context | VSF Context |
filters | CategorySearchQueryVariables | filters used to search for categories. A filter contains at least one attribute, a comparison operator, and the value that is being searched for. |
customQuery | CustomQuery | (Optional) (optional) - custom GraphQL query that extends the default query |
customHeaders | CustomHeaders | (Optional) (optional) - custom headers that extends the default headers |
Returns:
Promise<ApolloQueryResult<CategorySearchQuery>>