queryCategories( )

Creates a query to retrieve a list of categories.

Description

The queryCategories() function builds a query to retrieve a list of categories and returns a CategoriesQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining CategoriesQueryBuilder functions onto the query. CategoriesQueryBuilder functions enable you to sort, filter, and control the results queryCategories() returns.

queryCategories() runs with these CategoriesQueryBuilder defaults, which you can override:

limit(50)

PROPERTY	SUPPORTED FILTERS & SORTING
`_id`	`eq()`
`name`	`eq()`

Syntax

function queryCategories(options: QueryCategoriesOptions): CategoriesQueryBuilder

queryCategories Parameters

NAME

TYPE

DESCRIPTION

options

Optional

QueryCategoriesOptions

Optional fields.

Returns

Return Type:

CategoriesQueryBuilder

Was this helpful?

queryCategories example

Copy Code

1import { categories } from 'wix-events.v2';
2  
3 async function queryCategories() {
4   const { items } = categories.queryCategories().find();
5 }
6