descending( )


Adds a sort to a query, sorting by the specified properties in descending order.

The descending() function refines a CollectionsQueryBuilder 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:

  • Number: Sorts numerically.
  • Date: Sorts by date and time.
  • String: Sorts lexicographically, so '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.
Method Declaration
Copy
function descending(propertyNames: Array<string>): CollectionsQueryBuilder;
Method Parameters
propertyNamesArray<string>

Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.

Returns
JavaScript
const query = collections.queryCollections().descending("_id");
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

eq( )


Refines a query to match items where the specified property equals the specified value.

The eq() function refines a CollectionsQueryBuilder 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'.

Method Declaration
Copy
function eq(propertyName: string, value: any): CollectionsQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
JavaScript
const query = collections.queryCollections().eq("_id", "some-id");
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

exists( )


Refines a query to match items where the specified property contains a value.

The exists() function refines a CollectionsQueryBuilder to only match items where the value of the specified propertyName doesn't equal null or undefined. exists() checks for either existence or non-existence based on the boolean parameter. Note that exists() does match items where the value of the specified propertyName is an empty string or an invalid value. exists() is only useful for properties which don't contain default values and therefore their values may be unassigned.

Method Declaration
Copy
function exists(propertyName: string, value: boolean): CollectionsQueryBuilder;
Method Parameters
propertyNamestring

valueboolean
Returns
JavaScript
const query = collections.queryCollections().exists("description", true);
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

find( )


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.

Method Declaration
Copy
function find(): Promise<CollectionsQueryResult>;
Request
This method does not take any parameters
Returns
Return Type:Promise<CollectionsQueryResult>
JavaScript
const query = collections.queryCollections().find();
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

hasSome( )


Refines a query to match items whose specified property contains any of the specified values.

The hasSome() function refines a CollectionsQueryBuilder to match only items where the value of the specified propertyName equals any of the specified values. Matching strings with hasSome() is case-sensitive, so 'text' isn't equal to 'Text'. If the specified property is an array, hasSome() matches if any of that array's elements equal any of the specified values.

Method Declaration
Copy
function hasSome(
  propertyName: string,
  value: Array<any>,
): CollectionsQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with values.


valueArray<any>
Returns
JavaScript
const query = collections .queryCollections() .hasSome("labelIds", ["red", "blue", "purple"]);
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?

in( )


Refines a query to only match items where the specified property contains any of the values in the provided array of values.

The in() function refines a CollectionsQueryBuilder to match only items where the specified propertyName is equal to any of the values in the provided array. Matching strings with in() is case-sensitive, so 'text' isn't equal to 'Text'.

Method Declaration
Copy
function in(propertyName: string, value: any): CollectionsQueryBuilder
Method Parameters
propertyNamestring

valueany
Returns
JavaScript
const query = collections .queryCollections() .in(["labelIds", "colors"], ["red", "blue", "purple"]);
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?