eq( )

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

Description

The eq() function refines a BookingsQueryBuilder to only match items where the value of the specified property equals the specified value.

It only matches values of the same type. For example, a number value stored as a String type does not match the same number stored as a Number type.

Matching strings with eq() is case sensitive, so "text" is not equal to "Text".

Syntax

function eq(propertyName: string, value: *): BookingsQueryBuilder

eq Parameters

NAME

TYPE

DESCRIPTION

propertyName

string

The property whose value will be compared with value.

Supported properties:

_id
contactId
sessionId
status

value

The value to match against.

Returns

A BookingsQueryBuilder object representing the refined query.

Return Type:

BookingsQueryBuilder

Was this helpful?

Add an equals filter to a query

Copy Code

1let query = bookings.queryBookings().eq("status", "CANCELED");

Create a query, add an equals filter, and run it

Copy Code

1import { bookings } from "wix-bookings-backend";
2
3// ...
4
5bookings.queryBookings()
6  .eq("status", "CANCELED")
7  .find()
8  .then((results) => {
9    if (results.items.length > 0) {
10      const items = results.items;
11      const firstItem = items[0];
12      const totalCount = results.totalCount;
13      const pageSize = results.pageSize;
14      const currentPage = results.currentPage;
15      const totalPages = results.totalPages;
16      const hasNext = results.hasNext();
17      const hasPrev = results.hasPrev();
18      const length = results.length;
19      const query = results.query;
20    } else {
21      // handle case where no matching items found
22    }
23  })
24  .catch((error) => {
25    console.error(error);
26  });