Home > @vue-storefront/magento-api > categoryList

categoryList() function

Fetches the category list.

Signature:

export default function categoryList(context: Context, params: CategoryListQueryVariables, customQuery?: CustomQuery, customHeaders?: CustomHeaders): Promise<ApolloQueryResult<CategoryListQuery>>;

Parameters

Parameter Type Description
context Context VSF Context
params CategoryListQueryVariables
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<CategoryListQuery>>

Test your knowledge →