This class provides methods for performing operations on SimpleDateTime objects, such as instantiating objects, for exampleThe class is used to conduct operations on SimpleDateTime objects, for example, instantiating objects.
You can also use this class to perform calculate, change formats of the date-time operations, such as calculations, formatting or converting between date-time or convert between the formats.
SimpleDateTime(dateTime)
Instantiates Use this constructor to instantiate a new SimpleDateTime object with the current or transferred date/time. Specify the date and time value in the UTC timezone.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | String | N | '' |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | SimpleDateTime |
---|
linenumbers | true |
---|
|
const nowDateTime = new SimpleDateTime();
//
const registrationDateTime = new SimpleDateTime(record.registration_datetime);
//
const yearStartDateTime = new SimpleDateTime('2019-01-01 00:00:00');
//
const laborDayStart |
You can also use the values in relative format for the SimpleDateTime constructor. All formats are available in the Relative Formats article.
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | SimpleDateTime |
---|
linenumbers | true |
---|
|
const yesterdayDatetime = new SimpleDateTime('2019-05-01'); // 2019-05-01 00:00:00 |
addDays(days)
This method adds a specified number of days to the current SimpleDateTime object. The negative value of the parameter will subtract the days.
yesterday');
ss.info(yesterdayDatetime.getValue());
// Info: 2022-02-28 00:00:00
const tomorrowDatetime = new SimpleDateTime('tomorrow');
ss.info(tomorrowDatetime.getValue());
// Info: 2022-03-02 00:00:00
const yesterdayWorkdayDayStart = new SimpleDateTime('yesterday 06:30');
ss.info(yesterdayWorkdayDayStart.getValue());
// Info: 2022-02-28 06:30:00
const fistDayOfNextMonthStart = new SimpleDateTime('first day of next month 00:00');
ss.info(fistDayOfNextMonthStart.getValue());
// Info: 2022-04-01 00:00:00
const rangeStartDatetime = new SimpleDateTime(`first day of ${monthName}`);
ss.info(rangeStartDatetime .getValue());
// Info: 2022-02-01 00:00:00
const YEAR = 2022;
const MONTH = 2;
const monthDatetime = new SimpleDateTime(`${YEAR}-${String(MONTH).padStart(2, '0')}-02 00:00:00`);
const monthName = monthDatetime.getMonthUTC();
ss.info(monthName);
// Info: February |
addDays(days)
This method is used to change the number of days in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds days to the object, the negative value diminishes the number of days.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
days | integer | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addDays |
---|
linenumbers | true |
---|
|
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDays(3);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-04 08:12:10 |
addMonths(months)
This method is used to change the number of months in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds months to the object, the negative value diminishes the number of months.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
months | Integer | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addMonths |
---|
linenumbers | true |
---|
|
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addMonths(-1);
ss.info(registrationDateTime.getValue());
//Info: 2018-12-01 08:12:10 |
addSeconds(seconds)
This method is used to change the number of seconds in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds seconds to the object, the negative value diminishes the number of seconds.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
seconds | Integer | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addSeconds |
---|
linenumbers | true |
---|
|
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addSeconds(3600);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-01 09:12:10 |
addWeeks(weeks)
This method is used to change the number of weeks in the current SimpleDateTime object according to the local date and time. The positive value of the parameter adds weeks to the object, the negative value diminishes the number of weeksThe method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the days using local date and time values.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
daysweeks | integerInteger | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addDaysaddWeeks |
---|
linenumbers | true |
---|
|
const registrationDateTime = new SimpleDateTime('2019-01-01 08:12:10');
registrationDateTime.addDaysaddWeeks(31);
ss.info(registrationDateTime.getValue());
//Info: 2019-01-0408 08:12:10 |
addMonthsaddYears(
monthsyears)
This method adds a specified is used to change the number of months to years in the current SimpleDateTime object . The negative value of the parameter will subtract the months.The method determines according to the local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the months using local date and time values. The positive value of the parameter adds years to the object, the negative value diminishes the number of years.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
monthsyears | Integer | Y | N |
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addMonthsaddYears |
---|
linenumbers | true |
---|
|
const registrationDateTimecontractStartDateTime = new SimpleDateTime('2019-01-01 0800:1200:1000');
registrationDateTimecontractStartDateTime.addMonthsaddYears(-1);
ss.info(registrationDateTimecontractStartDateTime.getValue());
//Info: 20182020-1201-01 0800:1200:1000 |
addSecondsafter(
secondsdateTime)
This method adds a specified number of seconds to the current SimpleDateTime objectallows to compare the date specified by the ‘dateTime‘ parameter with the current date.
The method returns TRUE, if the current date is after the specified; otherwise returns FALSE.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
secondsdateTime | IntegerSimpleDateTime object | Y | N |
Return:
VoidThis method does not return a valueThe method returns TRUE if the current date is later than the date specified by the parameter; otherwise, returns FALSE. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addSecondsafter |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const registrationDateTimeendDateTime = new SimpleDateTime('2019-01-01 08:1200:1000');
registrationDateTime.addSeconds(3600const isStartAfterThanEnd = startDateTime.after(endDateTime);
ss.info(registrationDateTime.getValue(isStartAfterThanEnd));
// 2019-01-01 09:12:10 |
addWeeks(weeksbefore(dateTime)
This method adds a specified number of weeks to the current SimpleDateTime object. The negative value of the parameter will subtract the weeks.allows to compare the date specified by the ‘dateTime‘ parameter with the current date.
The method returns TRUE, if the current date is before the specified; otherwise returns falseThe method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the weeks using local date and time values.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
weeksdateTime | IntegerSimpleDateTime object | Y | N |
Return:
VoidThis method does not return a valueThe method returns TRUE if the current date is earlier than the date specified by the parameter; otherwise, returns FALSE. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addWeeksbefore |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const registrationDateTimeendDateTime = new SimpleDateTime('2019-01-01 08:1200:1000');
registrationDateTime.addWeeks(1;
const isStartBeforeEnd = startDateTime.before(endDateTime);
ss.info(registrationDateTime.getValue()isStartBeforeEnd);
// 2019-01-08 08:12:10 |
addYears(years)
This method adds a specified number of years to the current SimpleDateTime object. The negative value of the parameter will subtract the years.
compareTo(dateTime)
This method compares two date and time objects to determine whether they are equal and, if not, the method defines which goes after or before the otherThe method determines local date and time equivalent to the value saved by the SimpleDateTime object, then adds or subtracts the years using local date and time values.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
yearsdateTime | IntegerSimpleDateTime object | Y | N |
Return:
Void | This method does not return a value |
---|
0 | Dates are equal. |
1 | Object's date is after the date specified in the parameter. |
-1 | Object's date is before the date specified in the parameter. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | addYearscompareTo |
---|
linenumbers | true |
---|
|
const contractStartDateTimebegin = new SimpleDateTime('2019-04-01 08:15:00');
const end = new SimpleDateTime('2019-05-01 0001:00:00');
ss.info(begin.compareTo(end));
contractStartDateTime.addYears(1); // -1
ss.info(end.compareTo(begin)); // 1
ss.info(contractStartDateTimebegin.getValuecompareTo(begin)); // 2020-01-01 00:00:00 |
afterequals(dateTime)
This method allows to compare the date specified by the ‘dateTime‘ parameter with the current date. The method returns TRUE, if the current date is after the specified; otherwise returns FALSEcompares a datetime with an existing value to determine whether they are equal or not.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | SimpleDateTime object. | Y | N |
Return:
Type | Description |
---|
Boolean | The This method returns TRUE if the current date is later than the date specified by the parameterdate are equal; otherwise, it returns FALSE. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | afterequals |
---|
linenumbers | true |
---|
|
const startDateTimefirstDateTime = new SimpleDateTime('2018-01-01 0708:5800:3500');
const endDateTimesecondDateTime = new SimpleDateTime('20192018-01-01 08:0015:00');
const isStartLaterThanEndthirdDateTime = startDateTime.after(endDateTime new SimpleDateTime('2018-01-01 08:00:00');
ss.info(firstDateTime.equals(secondDateTime));
ss.info(thirdDateTime.infoequals(isStartLaterThanEndfirstDateTime));
// false |
before(dateTime)
This method allows to compare the date specified by the ‘dateTime‘ parameter with the current date.
The method returns TRUE, if the current date is before the specified; otherwise returns false.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | SimpleDateTime object | Y | N |
getDate()
This method returns the date saved by the SimpleDateTime object in the system time zone.
Return:
Boolean method returns TRUE if the current date is earlier than the date specified by the parameter; otherwise, returns FALSEdate in the default timezone. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | before |
---|
linenumbers | true |
---|
| Eclipse |
---|
title | getDate |
---|
linenumbers | true |
---|
|
const startDateTimeconst startDateTime = new SimpleDateTime('2018-01-01 07:58:35');
const endDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const isStartBeforeEnd = ss.info(startDateTime.beforegetDate(endDateTime));
ss.info(isStartBeforeEnd); // true |
compareTo(dateTime)
This method compares two date and time objects to determine whether they are equivalent or not.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | SimpleDateTime object | Y | N |
getDayOfMonthLocalTime()
This method returns the day of the month saved by the SimpleDateTime object in the current user's time zone.
Return:
0 | Dates are equal |
1 | Object's date is after the date specified in the parameter. |
-1 | Object's date is before the date specified in the parameter |
---|
Integer | The day of the month value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | compareTogetDaysofMonthsLocalTime |
---|
linenumbers | true |
---|
|
const firstDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(holidayDateTime.getDayOfMonthLocalTime());
const secondDateTime = new SimpleDateTime(//Info: 7 |
getDayOfMonthUTC()
This method returns the day of the month saved by the SimpleDateTime object in the UTC time zone.
Return:
Type | Description |
---|
Integer | The day of the month value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDaysofMonthsLocalTime |
---|
linenumbers | true |
---|
|
const holidayDateTime'2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('20182019-01-01 08:00:00');
ss.info(thirdDateTime.compareTo(secondDateTime )); // 007 08:00:00');
ss.info(firstDateTimeholidayDateTime.compareTogetDayOfMonthUTC(secondDateTime)); // 1
ss.info(secondDateTime.compareTo(firstDateTime)); // -1 |
equals(dateTime)
This method compares a datetime with an existing value if they are equal.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | SimpleDateTime object. | Y | N |
getDayOfWeekLocalTime()
This method returns the day of the week saved by the SimpleDateTime object in the current user's time zone.
Return:
Boolean | This method returns TRUE if the date are equal; otherwise, it returns FALSE.String | The day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | equalsgetDayOfWeekLocalTime |
---|
linenumbers | true |
---|
|
const firstDateTimeholidayDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const secondDateTime = new SimpleDateTime('2018-01-01 08:00:00');
const thirdDateTime = new SimpleDateTime('2018-01-0107 08:00:00');
ss.info(firstDateTimeholidayDateTime.equalsgetDayOfWeekLocalTime(secondDateTime)); // false
ss.info(thirdDateTime.equals(secondDateTime)); // true |
getDategetDayOfWeekUTC()
This method returns the date stored day of the week saved by the SimpleDateTime object , showed in the system time zone.
Return:
date in the default timezone.day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDategetDayOfWeekUTC |
---|
linenumbers | true |
---|
|
const startDateTimeholidayDateTime = new SimpleDateTime('2019-01-0107 08:00:00');
ss.info(startDateTimeholidayDateTime.getDategetDayOfWeekUTC());
// 2019-01-01 |
getDayOfMonthLocalTimegetDaysInMonthLocalTime()
This method returns the day number of days in the month saved by the SimpleDateTime object , showed in the current user's time zone.
Return:
Type | Description |
---|
Integer | The |
day the month
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDaysofMonthsLocalTimegetDaysInMonthLocalTime |
---|
linenumbers | true |
---|
|
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfMonthLocalTimegetDaysInMonthLocalTime());
//Info: 731 |
getDayOfMonthUTCgetDaysInMonthUTC()
This method returns the day number of days in the month saved by the SimpleDateTime object , showed in the UTC system time zone.
Return:
Type | Description |
---|
Integer | The |
day the month
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDaysofMonthsLocalTimegetDaysInMonthUTC |
---|
linenumbers | true |
---|
|
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-0701 08:00:00');
ss.info(holidayDateTimestartDateTime.getDayOfMonthUTCgetDaysInMonthUTC());
//Info: 731 |
getDayOfWeekLocalTimegetDisplayValue()
This method returns the day of the week saved by the SimpleDateTime object, showed date and time value in the current user's time zonedisplay format and timezone.
Return:
String | The day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat' |
---|
String | The date and time value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDayOfWeekLocalTimegetDisplayValue |
---|
linenumbers | true |
---|
|
const holidayDateTimestartDateTime = new SimpleDateTime('2019-01-07 0801 08:00:00');
ss.info(startDateTime.getDisplayValue()); // current user's timezone is Europe/Moscow
//Info: 2019-01-01 11:00:00');
ss.info(holidayDateTime.getDayOfWeekLocalTime()); // Mon |
getDayOfWeekUTCgetErrorMsg()
This method returns the day of the week saved by the SimpleDateTime object, showed in the system time zone.
Return:
error message if the SimpleDateTime object was incorrect.
Return:
Type | Description |
---|
String | The error message. |
Type | Description |
---|
String | The day of week value. Possible values: 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDayOfWeekUTCgetErrorMsg |
---|
linenumbers | true |
---|
|
const holidayDateTimestartDateTime = new SimpleDateTime('2019-zz-01-07 08:00:00');
ss.infoerror(holidayDateTimestartDateTime.getDayOfWeekUTCgetErrorMsg());
// Mon |
getDaysInMonthLocalTimeError: DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given |
getLocalDate()
This method returns the number of days in the month date saved by the SimpleDateTime object , showed in the current user's time zone.
Return:
Integer number of days valuedate in the user's time zone. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDaysInMonthLocalTimegetLocalDate |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getDaysInMonthLocalTimegetLocalDate());
// 31 |
getDaysInMonthUTCgetLocalTime()
This method returns the number of days in the month saved by the time saved in a SimpleDateTime object , showed in the system current user's time zone .
Return:
Integer number of days valuetime in the user's time zone. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDaysInMonthUTCgetLocalTime |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTime();
ss.info(startDateTime.getDaysInMonthUTC( "My local time is " + time.getByFormat('h:i:s'));
// 31 |
getDisplayValueInfo: My local time is 02:00:00 |
getMonthLocalTime()
This method gets the date and time value returns the month saved by SimpleDateTime object in the current user's display format and timezonetime zone.
Return:
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getDisplayValuegetMonthLocalTime |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getDisplayValuegetMonthLocalTime()) ;
// 2019-01-01 11:00:00 |
getErrorMsggetMonthUTC()
This method gets the error message if the SimpleDateTime object was incorrectreturns the month saved by SimpleDateTime object in the system time zone.
Return:
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getErrorMsggetMonthUTC |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-zz12-0131 0823:0045:00');
ss.info(startDateTime.getErrorMsggetMonthUTC());
// DateTimeZone::getOffset() expects parameter 1 to be DateTimeInterface, null given |
getLocalDategetNumericValue()
This method returns the date stored by the SimpleDateTime object, showed in the user's time zoneUnix timestamp, which stores the amount of seconds since January 1, 1970, 00:00:00.
Return:
String date in the user's time zone
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getLocalDategetNumericValue |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
ss.info(startDateTime.getLocalDategetNumericValue());
// 2019-01-01 |
getLocalTimegetTime()
This method returns a SimpleDateTime object that shows the piece of time in the user's time zoneof the SimpleDateTime object.
Return:
Type | Description |
---|
SimpleDateTime | The |
time in the user's time zone
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getLocalTimegetTime |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-01-01 08:00:00');
const time = startDateTime.getLocalTimegetTime();
ss.info( "My local time is " + time.getByFormat('h:mi:s')); // My local time is 02
//Info: 11:01:00 |
getMonthLocalTimegetValue()
This method returns the month saved by SimpleDateTime object, showed in the current user's time zonedate and time value in the internal format.
Return:
Stringnull | string | The date and time value |
of month
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getMonthLocalTimegetValue |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-1201-3101 2308:4500:00');
ss.info(startDateTime.getMonthLocalTimegetValue()); // January |
getMonthUTCgetWeekOfYearLocalTime()
This method returns the month saved by week's number saved by the SimpleDateTime object , showed in the system current user's time zone.
Return:
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getMonthUTCgetWeekOfYearLocalTime |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getMonthUTCgetWeekOfYearLocalTime());
//Info: December1 |
getNumericValuegetWeekOfYearUTC()
This method gets the timestamp which stores the amount of seconds since January 1, 1970, 00:00:00returns the number of the week saved by the SimpleDateTime object in the system time zone.
Return:
Type | Description |
---|
Integer | The |
timestamp valuenumber of the current week. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getNumericValuegetWeekOfYearUTC |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTime.getNumericValuegetWeekOfYearUTC());
//Info: 15463296001 |
getTimegetYearLocalTime()
This method returns a the year saved by the SimpleDateTime object that shows the piece of time of the SimpleDateTime objectin the current user's time zone.
Return:
SimpleDateTime | The Unix duration stampInteger | Four-digit year value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getTimegetYearLocalTime |
---|
linenumbers | true |
---|
|
const startDateTimeholidayDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
const time = startDateTime.getTime(');
ss.info(timeholidayDateTime.getByFormat('h:m:s'getYearLocalTime());
// 11:01:00 |
getValuegetYearUTC()
This method gets the date and time value in the internal formatreturns the year saved by the SimpleDateTime object in the system time zone.
Return:
null | string | The date and time value in the internal formatInteger | Four-digit year value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getValuegetYearUTC |
---|
linenumbers | true |
---|
|
const startDateTimeholidayDateTime = new SimpleDateTime('2019-0112-0131 0823:0045:00');
ss.info(startDateTimeholidayDateTime.getValuegetYearUTC());
//Info: 2019-01-01 08:00:00 |
getWeekOfYearLocalTimeisValid()
This method returns the number of the week saved by the SimpleDateTime object, showed in the user's time-zoneallows to determine if a specified value is a valid date and time.
Return:
Integer number of the current weekmethod returns TRUE if the value is a valid date and time; otherwise, it returns . |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getWeekOfYearLocalTimeisValid |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-12-31 23:45-01-01 08:00:00');
startDateTime.setValue('2011-aa-01 00:00:00');
ss.info(startDateTime.getWeekOfYearLocalTimeisValid());
//Info: 1false |
getWeekOfYearUTCsetValue(dateTime)
This method
returns the number of the week saved by the SimpleDateTime object, showed in the system time-zone.is intended to define the date and time value within the SimpleDateTime object.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | A string in the UTC timezone and the internal format of YYYY-MM-DD hh:mm:ss. | Y | N |
dateTime | A SimpleDateTime object. | Y | N |
dateTime | A JavaScript Number. It sets the value of the object using the Number value as milliseconds past January 1, 1970, 00:00:00. | Y | N |
Return:
Type | Description |
---|
Integer | The number of the current week. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getWeekOfYearUTC |
---|
linenumbers | true |
---|
|
const startDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(startDateTime.getWeekOfYearUTC()); // 1 |
getYearLocalTime()
This method returns the year saved by the SimpleDateTime object, showed in the user's time zone.
Return:
Integer | Four-digit year Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getYearLocalTimesetValue |
---|
linenumbers | true |
---|
|
const holidayDateTimestartDateTime = new SimpleDateTime('2019-12-31 23:45-01-01 08:00:00');
startDateTime.setValue('2020-01-01 12:00:00');
ss.info(holidayDateTimestartDateTime.getYearLocalTimegetValue());
//Info: 2020 |
getYearUTC(subtract(first, second)
This method returns the year saved by the SimpleDateTime object, showed in the system time zone.
Return:
Type | Description |
---|
Integer | Four-digit year value. |
amount of time between two SimpleDateTime values. Also, it can subtract the amount of time from the current SimpleDateTime object.
Note |
---|
Displaying of the final value using the getDisplayValue() method returns it considering the current user' timezone, unlike the getValue() method. It returns data only in UTC timezone. |
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
first | SimpleDateTime Object | Y | N |
second | SimpleDateTime Object | N | NULL |
Return:
Type |
---|
SimpleDuration object |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | getYearUTC |
---|
linenumbers | true |
---|
|
const holidayDateTime = new SimpleDateTime('2019-12-31 23:45:00');
ss.info(holidayDateTime.getYearUTC()); // 2019 |
isValid()
This method allows to determine if a specified value is a valid date and time.
Return:
Type | Description |
---|
Boolean | The method returns TRUE if the value is a valid date and time; otherwise, it returns .
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | isValidsubtract #1 |
---|
linenumbers | true |
---|
|
const startDateTimestartDatetime = new SimpleDateTime('2019-01-01 08:00:00');
startDateTime.setValue("2011-aa-01 00('2019-11-08 20:00:00"');
ss.info(startDateTime.isValid()); // false |
setValue(dateTime)
This method sets the date and time of the SimpleDateTime object.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
dateTime | A string in the local time zone and the internal format of yyyy-MM-dd HH:mm:ss. | Y | N |
dateTime | A SimpleDateTime object, | Y | N |
dateTime | A JavaScript Number. It sets the value of the object using the Number value as milliseconds past January 1, 1970, 00:00:00. | Y | N |
const endDatetime = new SimpleDateTime('2019-11-08 20:06:28');
const diffDuration = new SimpleDateTime().subtract(startDatetime, endDatetime);
ss.info(diffDuration.getDurationSeconds());
// Info: 388 |
Same example without using of the subtract
Return:
Type | Description |
---|
Void | This method does not return a value. |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse | title | setValue |
---|
linenumbers | true |
---|
|
const startDateTimestartDatetime = new SimpleDateTime('2019-0111-0108 0820:00:00');
startDateTime.setValueconst endDatetime = new SimpleDateTime('20202019-0111-0108 1220:0006:0028');
ss.info(startDateTime.getValue()); // 2020-01-01 12:00:00 |
subtract(first, second)
This method gets the duration between to SimpleDateTime values. Also, it can subtract the amount of time from the current SimpleDateTime object.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|
first | SimpleDateTime Object | Y | N |
first | SimpleTime Object | Y | N |
first | Number (milliseconds) | Y | N |
second | SimpleDateTime Object | N | NULL |
second | SimpleTime Object | N | NULL |
second | Number (milliseconds) | N | NULL |
const diffSeconds = endDatetime.getNumericValue() - startDatetime.getNumericValue();
ss.info(diffSeconds);
// Info: 388 |
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | subtract #2 |
---|
linenumbers | true |
---|
|
const datetime = new SimpleDateTime('2020-08-28 09:00:00');
datetime.subtract(3600);
ss.info(datetime.getValue());
//Info: 2020-08-28 08:00:00 |
Same example without using of the subtract
Return:
Type |
---|
SimpleDuration object |
Example:
Code Block |
---|
language | js |
---|
theme | Eclipse |
---|
title | subtract #2 |
---|
linenumbers | true |
---|
|
const startDateTimedatetime = new SimpleDateTime("2019-01-01 08:00:00");
const periodTime = new SimpleTime();
periodTime.setValue("00:00:20");
startDateTime.subtract(periodTime);
const afterSutractDateTime = startDateTime.getTime(('2020-08-28 09:00:00');
datetime.addSeconds(-3600);
ss.info(afterSutractDateTimedatetime.getByFormat('h:m:s'getValue());
// 01:12:40Info: 2020-08-28 08:00:00 |