CkDateTime JavaScript Reference Documentation

CkDateTime

Current Version: 11.4.0

A class for holding a date/time value, and for converting it to from many different formats. The power of this class is that the different date/time formats are implemented across many different operating systems. Many formats specific to Windows are available on Mac OS X, Linux/Unix, etc., and vice-versa. To convert a date/time from one format to another, simply set via one format, and get via another format. This is a freeware class because it is used by many commercial Chilkat components/libs.

Object Creation

Note: This is intended for running within a Chilkat.Js embedded JavaScript engine.

var obj = new CkDateTime();

Properties

DebugLogFilePath

DebugLogFilePath

· string

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

More Information and Examples

Example showing how to use DebugLogFilePath.

IsDst

IsDst

· int, read-only

This is the Daylight Saving Time flag. It can have one of three possible values: 1, 0, or -1. It has the value 1 if Daylight Saving Time is in effect, 0 if Daylight Saving Time is not in effect, and -1 if the information is not available.

Note: This is NOT the DST for the current system time. It is the DST that was in effect at the date value contained in this object.

LastErrorHtml

LastErrorHtml

· string, read-only

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastErrorText

LastErrorText

· string, read-only

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

LastErrorXml

· string, read-only

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

LastMethodSuccess

LastMethodSuccess

· boolean

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

UtcOffset

UtcOffset

· int, read-only

For the current system's timezone, returns the number of seconds offset from UTC for this date/time. The offset includes daylight savings adjustment. Local timezones west of UTC return a negative offset.

VerboseLogging

VerboseLogging

· boolean

If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version

Version

· string, read-only

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AddDays

var success = AddDays(numDays);

· return: boolean; true for success, false for failure
· numDays: int

Adds an integer number of days to the date/time. To subtract days, pass a negative integer.

Returns true for success, false for failure.

AddSeconds

var success = AddSeconds(numSeconds);

· return: boolean; true for success, false for failure
· numSeconds: int

Introduced in version 9.5.0.65

Adds an integer number of seconds to the date/time. To subtract seconds, pass a negative integer.

Returns true for success, false for failure.

More Information and Examples

DateTime - Add or Subtract Seconds

DeSerialize

DeSerialize(serializedDateTime);

· return: undefined
· serializedDateTime: string

Loads the date/time with a string having the format as produced by the Serialize method, which is a string of SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1/0.

DiffSeconds

var intVal = DiffSeconds(dateTimeArg);

· return: int
· dateTimeArg: CkDateTime

Introduced in version 9.5.0.65

Returns the difference in seconds between the dateTimeArg and this date/time. The value returned is this object's date/time - dateTimeArg's date/time. For example, if the returned value is positive, then this object's date/time is more recent than dateTimeArg's date/time. If the return value is negative, then this object's date/time is older than dateTimeArg's date/time.

More Information and Examples

Compute Difference Between Two DateTime Strings

ExpiresWithin

var boolVal = ExpiresWithin(n, units);

· return: boolean
· n: int
· units: string

Introduced in version 9.5.0.67

Returns true if the date/time is within n seconds/minutes/hours/days of the current system date/time. Otherwise returns false. The units can be seconds, minutes, hours, or days (plural or singular).

More Information and Examples

Date/Time Expires Within N Seconds/Minutes/Hours/Days

GetAsDateTimeTicks

var int64val = GetAsDateTimeTicks(bLocal);

· return: int64
· bLocal: boolean

Returns the date/time as a 64-bit integer .NET DateTime value.

bLocal indicates whether a local or UTC time is returned.

This is a date and time expressed in the number of 100-nanosecond intervals that have elapsed since January 1, 0001 at 00:00:00.000 in the Gregorian calendar.

The DateTime value type represents dates and times with values ranging from 12:00:00 midnight, January 1, 0001 Anno Domini (Common Era) through 11:59:59 P.M., December 31, 9999 A.D. (C.E.).

Time values are measured in 100-nanosecond units called ticks, and a particular date is the number of ticks since 12:00 midnight, January 1, 0001 A.D. (C.E.) in the GregorianCalendar calendar (excluding ticks that would be added by leap seconds). For example, a ticks value of 31241376000000000L represents the date, Friday, January 01, 0100 12:00:00 midnight. A DateTime value is always expressed in the context of an explicit or default calendar.

GetAsDosDate

var uintVal = GetAsDosDate(bLocal);

· return: unsigned int
· bLocal: boolean

Returns the date/time as a 32-bit DOS date/time bitmask.

bLocal indicates whether a local or UTC time is returned.

The DOS date/time format is a bitmask:


			   24                16                 8                 0
	    +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
	    |Y|Y|Y|Y|Y|Y|Y|M| |M|M|M|D|D|D|D|D| |h|h|h|h|h|m|m|m| |m|m|m|s|s|s|s|s|
	    +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
	     \___________/\________/\_________/ \________/\____________/\_________/
		 year        month       day      hour       minute        second

The year is stored as an offset from 1980. Seconds are stored in two-second increments. (So if the second value is 15, it actually represents 30 seconds.)

GetAsIso8601

var strVal = GetAsIso8601(formatStr, bLocal);

· return: string
· formatStr: string
· bLocal: boolean

Introduced in version 9.5.0.65

Returns the date/time in a compatible ISO 8601 format according to the format specified in formatStr.. Examples of ISO 8601 formats include the following:

    YYYY-MM-DD

    YYYY-MM-DDThh:mmTZD

    YYYY-MM-DDThh:mm:ssTZD

    YYYY-MM-DDThh:mm:ss:sssTZD

For the date portion of these formats, YYYY is a four-digit year representation, MM is a two-digit month, and DD is a two-digit day. For the time portion, hh is the hour in 24-hour notation, mm is the two-digit minutes, ss is the two-digit seconds, and sss is the 3-digit milliseconds. A time designator T separates the date and time portions of the string, while a time zone designator TZD specifies a time zone (UTC).

bLocal indicates whether a local or UTC time is returned.

Note: The bLocal argument is interpreted as the reverse of what is intended . The problem was discovered just after releasing v9.5.0.65. It will be fixed in the next version update.

Returns null on failure

More Information and Examples

DateTime - Get in ISO 8601 Compatible Format

GetAsRfc822

var strVal = GetAsRfc822(bLocal);

· return: string
· bLocal: boolean

Returns the date/time as an RFC822 formatted string. (An RFC822 format string is what is found in the Date header field of an email, such as Wed, 18 Oct 2017 09:08:21 GMT.)

bLocal indicates whether a local or UTC time is returned.

Returns null on failure

GetAsTimestamp

var strVal = GetAsTimestamp(bLocal);

· return: string
· bLocal: boolean

Introduced in version 9.5.0.58

Returns the date/time as an RFC 3339 formatted string, such as 1990-12-31T23:59:60Z. (This is an ISO 8061 format like the following: YYYY-MM-DDThh:mm:ssTZD)

bLocal indicates whether a local or UTC time is returned.

Returns null on failure

More Information and Examples

Get Current Date/Time as Timestamp (YYYY-MM-DDThh:mm:ssTZD)

GetAsUnixTime

var uintVal = GetAsUnixTime(bLocal);

· return: unsigned int
· bLocal: boolean

Returns the date/time as a Unix time value, which is the number of seconds elapsed since 00:00:00 UTC on January 1, 1970.

bLocal indicates whether the date/time returned is local or UTC.

GetAsUnixTime64

var int64val = GetAsUnixTime64(bLocal);

· return: int64
· bLocal: boolean

The same as GetUnixTime, except returns the date/time as a 64-bit integer.

bLocal indicates whether a local or UTC time is returned.

Note: 64-bit integers are needed after Jan 19, 2038. The Y2038 problem happens because some systems store Unix time as a signed 32-bit number of seconds since Jan 1, 1970. This number runs out on Jan 19, 2038, causing the time to wrap around to a date in 1901.

GetAsUnixTimeStr

var strVal = GetAsUnixTimeStr(bLocal);

· return: string
· bLocal: boolean

Introduced in version 9.5.0.65

Returns the time in Unix format (in seconds since the epoch: 00:00:00 UTC on 1 January 1970).

bLocal indicates whether the date/time returned is local or UTC.

Returns null on failure

More Information and Examples

DateTime - Get as Unix Time String

OlderThan

var boolVal = OlderThan(n, units);

· return: boolean
· n: int
· units: string

Introduced in version 9.5.0.67

Returns true if the date/time is older than the current system date/time by n seconds/minutes/hours/days. Otherwise returns false. The units can be seconds, minutes, hours, or days (plural or singular).

More Information and Examples

Date/Time Older-Than N Seconds/Minutes/Hours/Days

Serialize

var strVal = Serialize();

· return: string

Serializes the date/time to a us-ascii string that can be imported at a later time via the DeSerialize method. The format of the string returned by this method is not intended to match any published standard. It is formatted to a string with SPACE separated integers containing (in this order) year, month, day, hour, minutes, seconds, and a UTC flag having the value of 1 or 0.

Returns null on failure

SetFromCurrentSystemTime

var boolVal = SetFromCurrentSystemTime();

· return: boolean

Sets the date/time from the current system time.

SetFromDateTimeTicks

var boolVal = SetFromDateTimeTicks(bLocal, ticks);

· return: boolean
· bLocal: boolean
· ticks: int64

Sets the date/time from a .NET DateTime value represented in ticks. See GetAsDateTimeTicks for more information.

bLocal indicates whether the passed in date/time is local or UTC.

SetFromDosDate

var boolVal = SetFromDosDate(bLocal, t);

· return: boolean
· bLocal: boolean
· t: unsigned int

Sets the date/time from a 32-bit DOS date/time bitmask. See GetAsDosDate for more information.

SetFromDtObj

var success = SetFromDtObj(dt);

· return: boolean; true for success, false for failure
· dt: CkDtObj

Introduced in version 9.5.0.47

Sets the date/time from a Chilkat Dt object.

Returns true for success, false for failure.

SetFromNtpServer

var success = SetFromNtpServer(jsonStr);

· return: boolean; true for success, false for failure
· jsonStr: string

Introduced in version 9.5.0.96

Sets the date/time by sending a query to an NTP server.

Note: The SetFromNtpServer method is available starting in v9.5.0.96 for most Chilkat builds, but not all. If the SetFromNtpServer method is not present, contact support@chilkatsoft.com for a hotfix build. It should be available in all programming languages/platforms starting in v9.5.0.97

Returns true for success, false for failure.

More Information and Examples

Query NTP Server for Current Date/Time

SetFromNtpTime

var boolVal = SetFromNtpTime(ntpSeconds);

· return: boolean
· ntpSeconds: int

Introduced in version 9.5.0.50

Sets the date/time from a 32-bit NTP time value. ntpSeconds is the number of seconds since 00:00 (midnight) 1 January 1900 GMT.

SetFromRfc822

var success = SetFromRfc822(rfc822Str);

· return: boolean; true for success, false for failure
· rfc822Str: string

Sets the date/time from an RFC822 date/time formatted string. Here are some examples of RFC822 formatted date/times:

Tue, 15 Nov 2022 22:00:58 +0000
Tue, 15 Nov 2022 20:21:50 +0100
Tue, 01 Nov 2022 18:09:41 -0600

Returns true for success, false for failure.

SetFromTimestamp

var success = SetFromTimestamp(timestamp);

· return: boolean; true for success, false for failure
· timestamp: string

Introduced in version 9.5.0.58

Sets the date/time from an RFC 3339 timestamp format. (such as 1990-12-31T23:59:60Z:)

(This is an ISO 8061 format like the following: YYYY-MM-DDThh:mm:ssTZD)

Note: Starting in v9.5.0.77, strings formatted as YYMMDDhhmmssZ, such as 181221132225Z, can also be passed to this method.

Returns true for success, false for failure.

More Information and Examples

How to Parse a TimeStamp (such as 2016-11-11T14:32:17.0908971Z)

SetFromUlid

var success = SetFromUlid(bLocal, ulid);

· return: boolean; true for success, false for failure
· bLocal: boolean
· ulid: string

Introduced in version 9.5.0.94

Sets this object's date/time using the timestamp embedded in the ulid. If the ulid was not a valid ULID, returns false and the date/time is not set. bLocal indicates whether the ulid uses a local time or UTC time.

Returns true for success, false for failure.

More Information and Examples

Extract Timestamp from ULID

SetFromUnixTime

var boolVal = SetFromUnixTime(bLocal, t);

· return: boolean
· bLocal: boolean
· t: unsigned int

Sets the date/time from a UNIX time value.

bLocal indicates whether the passed in date/time is local or UTC.

SetFromUnixTime64

var boolVal = SetFromUnixTime64(bLocal, t);

· return: boolean
· bLocal: boolean
· t: int64

The same as SetFromUnixTime, except that it uses a 64-bit integer to solve the Y2038 problem.

bLocal indicates whether the passed in date/time is local or UTC.

Note: 64-bit integers are needed after Jan 19, 2038. The Y2038 problem happens because some systems store Unix time as a signed 32-bit number of seconds since Jan 1, 1970. This number runs out on Jan 19, 2038, causing the time to wrap around to a date in 1901.

ToDtObj

ToDtObj(bLocal, dtObj);

· return: undefined
· bLocal: boolean
· dtObj: CkDtObj

Introduced in version 11.0.0

Copies the date/time to the dtObj. Gets the date/time in the local time if bLocal is true, or GMT if bLocal is false.

UlidGenerate

var strVal = UlidGenerate(bLocal);

· return: string
· bLocal: boolean

Introduced in version 9.5.0.94

Generates and returns a new ULID using this object's date/time value. bLocal indicates whether to use local time or UTC time.

Returns null on failure

More Information and Examples

UlidIncrement

var boolVal = UlidIncrement(ulid);

· return: boolean
· ulid: CkStringBuilder

Introduced in version 9.5.0.94

Increments the ULID that is passed in ulid.

More Information and Examples

Generate Monotonic ULIDs

UlidValidate

var success = UlidValidate(ulid);

· return: boolean; true for success, false for failure
· ulid: string

Introduced in version 9.5.0.94

Validates the ulid. Returns true if the ulid is valid, otherwise returns false.

Returns true for success, false for failure.

More Information and Examples

Validate a ULID