Introduction

When you execute a query with the find() function, it returns a Promise that resolves to a LabelsQueryResult object. This object contains the items that match the query, information about the query itself, and functions for paging through the query results.

Did this help?

items

itemsArray<Label>Read-only

Returns the items that match the query.

The current page of items retrieved by the query.

List of labels.

Note: When no items match the query, the items array is empty.

To paginate your query results, use the LabelsQueryResult pagination properties and functions.

Perform a query and get the returned items from the result
JavaScript
import { Permissions, webMethod } from "wix-web-module";
import { contacts } from "wix-crm-backend";

export const getQueryResultItems = webMethod(Permissions.Anyone, () => {
  return contacts
    .queryLabels()
    .limit(5)
    .find()
    .then((results) => {
      if (results.items.length > 0) {
        return results.items;
      } else {
        console.log("No items found");
      }
    })
    .catch((error) => {
      console.error(error);
    });
});

/* items:
 * [
 *   {
 *     "_createdDate": "2021-01-20T06:55:58.000Z",
 *     "displayName": "White Glove Treatment",
 *     "key": "custom.white-glove-treatment",
 *     "labelType": "USER_DEFINED",
 *     "namespace": "custom",
 *     "_updatedDate": "2021-01-20T06:55:58.000Z"
 *   },
 *   {
 *     "_createdDate": "2021-01-20T06:55:47.000Z",
 *     "displayName": "At Risk",
 *     "key": "custom.at-risk",
 *     "labelType": "USER_DEFINED",
 *     "namespace": "custom",
 *     "_updatedDate": "2021-01-20T06:55:47.000Z"
 *   },
 *   {
 *     "_createdDate": "2021-01-20T00:31:41.000Z",
 *     "displayName": "Active Customer",
 *     "key": "custom.active-customer",
 *     "labelType": "USER_DEFINED",
 *     "namespace": "custom",
 *     "_updatedDate": "2021-01-20T00:31:41.000Z"
 *   },
 *   {
 *     "displayName": "Customers",
 *     "key": "contacts.customers",
 *     "labelType": "SYSTEM",
 *     "namespace": "contacts",
 *   },
 *   {
 *     "displayName": "Contacted Me",
 *     "key": "contacts.contacted-me",
 *     "labelType": "SYSTEM",
 *     "namespace": "contacts",
 *   }
 * ]
 */
Did this help?

length

lengthnumberRead-only

Returns the number of items in the current results page.

The page size is defined by the limit() function, can be retrieved using the pageSize property, and navigating through pages is done with the prev() and next() functions.

JavaScript
let resultLength = results.length; // 20
Did this help?

pageSize

pageSizenumberRead-only

Returns the query page size.

The page size is defined by the limit() function, can be retrieved using the pageSize property, and navigating through pages is done with the prev() and next() functions.

JavaScript
let resultPageSize = results.pageSize; // 50
Did this help?