startsWith( )

Refines a query to match items whose specified property value starts with a specified string.

Description

The startsWith() function refines a PublicPlansQueryBuilder to only match items where the value of the specified property starts with the defined string. Matching with startsWith() is case-sensitive, so "TEXT" does not start with "tex".

You can only use startsWith() with a property whose value is a String.

Syntax

function startsWith(propertyName: string, string: string): PublicPlansQueryBuilder

startsWith Parameters

NAME

TYPE

DESCRIPTION

propertyName

string

The property whose value will be compared with the string.

Supported property: slug

string

The string to look for at the beginning of the specified property value.

Returns

A PublicPlansQueryBuilder object representing the refined query.

Return Type:

PublicPlansQueryBuilder

Was this helpful?

Add a "starts with" filter to a query

Copy Code

1const newQuery = queryPublicPlans().startsWith("slug", "gold");

Create a query, add a "starts with" filter, and run it

Copy Code

1import wixPricingPlansBackend from 'wix-pricing-plans-backend';
2
3// ...
4
5wixPricingPlansBackend.queryPublicPlans()
6  .startsWith("slug", "gold")
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  });