limit( )

Limits the number of items the query returns.

Description

The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. The next() and prev() functions are used to navigate the pages of a query result.

By default, limit is set to 50.

The maximum value that limit() can accept is 1000.

Syntax

function limit(limit: string): LabelsQueryBuilder

limit Parameters

NAME

TYPE

DESCRIPTION

limit

string

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

Returns

A LabelsQueryBuilder object that contains the refined query.

Return Type:

LabelsQueryBuilder

Was this helpful?

Add a limit to a query

Copy Code

1const query = contacts.queryLabels().limit(10);

Create a query, add a limit, and run it

Copy Code

1import { Permissions, webMethod } from 'wix-web-module';
2import { contacts } from 'wix-crm-backend';
3
4export const myQueryLabelsFunction = webMethod(Permissions.Anyone, () => {
5  return contacts.queryLabels()
6    .limit(10)
7    .find()
8    .then((results) => {
9      if (results.items.length > 0) {
10        const items = results.items;
11        const firstItem = items[0];
12        const pageSize = results.pageSize;
13        const hasNext = results.hasNext();
14        const hasPrev = results.hasPrev();
15        const length = results.length;
16        const query = results.query;
17
18        return items;
19      } else {
20        // Handle case where no matching items found
21      }
22    })
23    .catch((error) => {
24      console.error(error);
25    });
26
27});