@kinaxis/date-helpers v1.1.1
date-helpers
Helper functions and constants for manipulating dates.
Documentation
Constants
This module defines the following constants:
| Name | Type | Description |
|---|---|---|
| PAST_DATE | Date | Represents a date at some time in the past |
| FUTURE_DATE | Date | Represents a date at some time in the future |
| UNDEFINED_DATE | Date | Represents an invalid date |
| FIRST_VALID_DATE | Date | The first date that RapidResponse can represent |
| FIRST_VALID_DATE_VALUE | number | The numeric value of FIRST_VALID_DATE |
| LAST_VALID_DATE | Date | The last date that RapidResponse can represent |
| LAST_VALID_DATE_VALUE | number | The numeric value of LAST_VALID_DATE |
CAUTION: Use the above defined constants instead of manually creating and assigning values for these. Future versions of the library or the embedded algorithms runtime may change the values of these date constants.
For more information about RapidResponse date constants, see https://help.kinaxis.com/20162/GlobalHelp/Content/RR_DataModel/Calendar_and_date_calcs/Date_constants.htm.
Functions
createDate(numberOfDays)
Creates a new Date object using the number of days since January 1, 1970.
| Argument | Type | Description |
|---|---|---|
| numberOfDays | number | The number of days since January 1, 1970 |
Return value: The Date which is numberOfDays days after January 1, 1970.
dateToDays(date)
Converts a Date to number of days since January 1, 1970.
| Argument | Type | Description |
|---|---|---|
| date | Date | The date to convert |
Return value: The number of days between January 1, 1970 and date. Invalid dates return 65534.
isValidDate(value)
Validates if a given unknown value is a valid Date
| Argument | Type | Description |
|---|---|---|
| value | unknown | The value to validate |
Return value: true if value is a valid Date. Otherwise false
clipDate(date)
Checks if a date is within RapidResponse date bounds and, if not, converts it to the appropriate constant value. For example, a date greater than LAST_VALID_DATE will be converted to FUTURE_DATE.
| Argument | Type | Description |
|---|---|---|
| date | Date | The date to clip |
Return value: Returns date if the value is within the range FIRST_VALID_DATE, LAST_VALID_DATE. Returns PAST_DATE if date is less than FIRST_VALID_DATE or FUTURE_DATE if date is greater than LAST_VALID_DATE. Returns UNDEFINED_DATE if date is invalid.
isDateConstant(date)
Determines if a date has the value of a date constant.
| Argument | Type | Description |
|---|---|---|
| date | Date | The date to check |
Return value: true if date has the value of a date constant (i.e., PAST_DATE, FUTURE_DATE, or UNDEFINED_DATE). Otherwise false.
Please contact support@kinaxis.com if you experience any issues.
Copyright © 2022 Kinaxis. All Rights Reserved.