ge( )

Refines a query to match items whose specified property value is greater than or equal to the specified value.

The ge() function refines a BookingsQueryBuilder to only match items where the value of the specified property is greater than or equal to 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.

If a property contains a number as a String, that value will be compared alphabetically and not numerically. Items that do not have a value for the specified property are ranked lowest.

The following types of properties can be compared:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so "abc" is greater than or equal to "ABC" (because of the greater than), but "ABC" is not greater than or equal to "abc".
Method Declaration
Copy
Method Parameters
propertyNamestringRequired

The property whose value will be compared with value.

Supported properties:

  • startTime
  • _createdDate
valueunionRequired

The value to match against.

Returns
Return Type:BookingsQueryBuilder
Was this helpful?
Yes
No