eq( )

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

Description

The eq() function refines a PublicPlansQueryBuilder 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".

If the value of the propertyName property is an Array, eq() includes items in which any of the elements of the Array match the specified value.

Syntax

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

eq Parameters

NAME

TYPE

DESCRIPTION

propertyName

string

The property whose value will be compared with value.

Supported properties:

_id
primary
slug
_createdDate
_updatedDate

value

The value to match against.

Returns

A PublicPlansQueryBuilder object representing the refined query.

Return Type:

PublicPlansQueryBuilder

Was this helpful?

Add an "equals" filter to a query

Copy Code

1const query = wixPricingPlansBackend.queryPublicPlans().eq("primary", true);

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

Copy Code

1import wixPricingPlansBackend from 'wix-pricing-plans-backend';
2
3// ...
4
5wixPricingPlansBackend.queryPublicPlans()
6  .eq("primary", false)
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    const queryError = error;
26  });