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 MembersQueryBuilder 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): MembersQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
JavaScript
const query = members.queryMembers.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 MembersQueryBuilder 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): MembersQueryBuilder;
Method Parameters
propertyNamestring

valueboolean
Returns
JavaScript
const query = members.queryMembers.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<MembersQueryResult>;
Request
This method does not take any parameters
Returns
Return Type:Promise<MembersQueryResult>
JavaScript
const query = members.queryMembers.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 MembersQueryBuilder 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>): MembersQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with values.


valueArray<any>
Returns
JavaScript
const query = members.queryMembers.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 MembersQueryBuilder 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): MembersQueryBuilder
Method Parameters
propertyNamestring

valueany
Returns
JavaScript
const query = members.queryMembers.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): MembersQueryBuilder;
Method Parameters
limitnumber

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

Returns
JavaScript
const query = members.queryMembers.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 MembersQueryBuilder 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): MembersQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
JavaScript
const query = members.queryMembers.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?

skip( )


Developer Preview

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

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.

Method Declaration
Copy
function skip(skip: number): MembersQueryBuilder;
Method Parameters
skipnumber

Number of items to skip in the query results before returning the results.

Returns
JavaScript
const query = members.queryMembers.skip(10);
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 MembersQueryBuilder 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): MembersQueryBuilder;
Method Parameters
propertyNamestring

Property whose value is compared with string.


valuestring
Returns
JavaScript
const query = members.queryMembers.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?