RelativeDate.isRange

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

Whether the relative date represents a range of dates or a specific moment in time.

For relative date ranges that you obtain from the query.RelativeDateRange enum, the value of this property is true (the relative date represents a range of dates). For all other relative dates (such as those that you create using query.createRelativeDate(options)), the value of this property is false (the relative date represents a specific moment in time).

Type

boolean (read-only)

Module

N/query Module

Parent Object

query.RelativeDate

Sibling Object Members

RelativeDate Object Members

Since

2019.1

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/query Module Script Samples.

            // Add additional code
...
var myRelativeDate = query.createRelativeDate({ dateId: query.DateId.WEEKS_AGO, value: 2
}); // isARange is false
var isARange = myRelativeDate.isRange; // isAnotherRange is true
var isAnotherRange = query.RelativeDateRange.LAST_MONTH_ONE_FISCAL_YEAR_AGO.isRange;
...
// Add additional code

Syntax

Related Topics