Adds a sort to a query, sorting by the specified properties in ascending order.
The ascending()
function refines a CategoriesQueryBuilder
to sort by the value of propertyName
in ascending order.
You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. ascending()
sorts the results in the order the properties are passed.
You can sort the following types:
'abc'
comes after 'XYZ'
.
If a property contains a number stored as a string (for example, '0'
), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.function ascending(propertyNames: Array<string>): CategoriesQueryBuilder;
Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
const query = categories.queryCategories.ascending("_createdDate");
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Adds a sort to a query, sorting by the specified properties in descending order.
The descending()
function refines a CategoriesQueryBuilder
to sort by the value of propertyName
in descending order.
You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. descending()
sorts the results in the order the properties are passed.
You can sort the following types:
'abc'
comes after 'XYZ'
.
If a property contains a number stored as a string (for example, '0'
), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.function descending(propertyNames: Array<string>): CategoriesQueryBuilder;
Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.
const query = categories.queryCategories.descending("_createdDate");
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Refines a query to match items where the specified property equals the specified value.
The eq()
function refines a CategoriesQueryBuilder
to match only items where the value of the specified propertyName
equals the specified value
.
eq()
matches only values of the same type. For example, 0
stored as a number doesn't match '0'
stored as a string.
Matching strings with eq()
is case-sensitive, so 'text'
isn't equal to 'Text'
.
function eq(propertyName: string, value: any): CategoriesQueryBuilder;
Property whose value is compared with value
.
Value to compare against.
const query = categories.queryCategories.eq("_id", "some-id");
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Returns the query results.
The find()
function returns a Promise that resolves to the query results and metadata.
The Promise is rejected if find()
is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.
function find(): Promise<CategoriesQueryResult>;
const query = categories.queryCategories.find();
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Limits the number of items the query returns.
The limit()
function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.
You can use the next()
and prev()
functions to navigate the pages of a query result.
function limit(limit: number): CategoriesQueryBuilder;
Number of items to return, which is also the pageSize
of the results object.
const query = categories.queryCategories.limit(10);
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
Sets the number of items to skip before returning query results.
The skip()
function defines the number of results to skip before returning new query results.
For example, if you query a collection and 50 items match your query, but you set skip()
to 10
, the first 10 items that match are ignored, and the 11th through 50th items are returned.
function skip(skip: number): CategoriesQueryBuilder;
Number of items to skip in the query results before returning the results.
const query = categories.queryCategories.skip(10);
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.