ascending( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The ascending() function refines a RulesQueryBuilder 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:

  • 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 ascending(propertyNames: Array<string>): RulesQueryBuilder;
Method Parameters
propertyNamesArray<string>

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

Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.ascending("_id");
Errors

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

Did this help?

descending( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The descending() function refines a RulesQueryBuilder 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>): RulesQueryBuilder;
Method Parameters
propertyNamesArray<string>

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

Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.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( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The eq() function refines a RulesQueryBuilder 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): RulesQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.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( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The exists() function refines a RulesQueryBuilder 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 boolen 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): RulesQueryBuilder;
Method Parameters
propertyNamestring

valueboolean
Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.exists("description", "some-description");
Errors

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

Did this help?

find( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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<RulesQueryResult>;
Request
This method does not take any parameters
Returns
Return Type:Promise<RulesQueryResult>
JavaScript
const query = serviceFees.queryRules.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( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The hasSome() function refines a RulesQueryBuilder 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>): RulesQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with values.


valueArray<any>
Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.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( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The in() function refines a RulesQueryBuilder 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): RulesQueryBuilder
Method Parameters
propertyNamestring

valueany
Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.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?

limit( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Method Declaration
Copy
function limit(limit: number): RulesQueryBuilder;
Method Parameters
limitnumber

Number of items to return, which is also the pageSize of the results object.

Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.limit(10);
Errors

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

Did this help?

ne( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a query to match items where the specified property doesn't equal the specified value.

The ne() function refines a RulesQueryBuilder to match only items where the value of the specified propertyName doesn't equal the specified value. ne() 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 ne() is case-sensitive, so 'text' isn't equal to 'Text'.

Method Declaration
Copy
function ne(propertyName: string, value: any): RulesQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.ne( "_id", "bb19b637-74ce-55d3-ae32-430b588051da", );
Errors

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

Did this help?

skipTo( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a query that skips to a specific record.

The skipTo() function refines a RulesQueryBuilder to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the cursors object in previous call's response. Then you can skip to cursors.prev to return items before the cursor, or cursors.next to return items after the cursor.

When using skipTo(), the filters and the sorting order of the original query can't be changed. Only the limit() property of the query can be changed.

Method Declaration
Copy
function skipTo(cursor: string): RulesQueryBuilder;
Method Parameters
cursorstring

A pointer to specific record

Returns
Return Type:RulesQueryBuilder
JavaScript
import { serviceFees } from "wix-restaurants.v2"; export async function myQueryFunction() { const results = await serviceFees.queryRules().find(); const nextCursor = results.cursors.next; return serviceFees.queryRules().skipTo(nextCursor).find(); }
Errors

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

Did this help?

startsWith( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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

The startsWith() function refines a RulesQueryBuilder to match only items where the value of the specified propertyName starts with the specified string. Matching with startsWith() is case-sensitive, so 'TEXT' doesn't start with 'text'. You can only use startsWith() with a property whose value is a string.

Method Declaration
Copy
function startsWith(propertyName: string, value: string): RulesQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with string.


valuestring
Returns
Return Type:RulesQueryBuilder
JavaScript
const query = serviceFees.queryRules.startsWith("_id", "L");
Errors

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

Did this help?