bajaScript

Class: Date

baja. Date

new Date()

Represents a baja:Date in BajaScript.

Date represents a specific day, month, and year.

When creating a Simple, always use the make() method instead of
creating a new Object.

Extends

Members

<static> DEFAULT :baja.Date

Default Date instance.

Type:

Methods

<static> make(obj)

Make a Date.

Parameters:
Name Type Description
obj Object

the Object Literal.

Properties
Name Type Argument Description
year Number | baja.Simple

(any baja:Number type)
month Number | baja.Simple | baja.FrozenEnum

(any baja:Number
type) (0-11) or a baja:Month FrozenEnum for the month of the year.
day Number | baja.Simple

(1-31). (any baja:Number type)
jsDate Date <optional>

A JavaScript Date used to specify the year,
month and day. If defined, this will override the year, month and day
arguments.
Returns:
Type
baja.Date
Example
//An Object Literal is used for the method's arguments...
  var d1 = baja.Date.make({
    year: 2008,
    month: baja.$("baja:Month").get("december"),
    day: 24
  });
  
  // ...or from a JavaScript Date...
  var d2 = baja.Date.make({
    jsDate: date
  });

<static> today()

Return a Date that maps to the current day.

Returns:
Type
baja.Date

decodeAsync(str [, batch])

The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.

The default implementation just returns decodeFromString directly.

Parameters:
Name Type Argument Description
str string
batch baja.comm.Batch <optional>

optional batch to use
Inherited From:
Returns:

may return the Simple instance
directly, or a Promise resolving to same - so wrap in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

decodeFromString(str)

Decode a Date from a String. Expects ISO 8601 encoding (yyyy-mm-dd).

Parameters:
Name Type Description
str String
Overrides:
Returns:
Type
baja.Date

encodeToString()

Encode the Date to a String. Uses ISO 8601 encoding (yyyy-mm-dd).

Overrides:
Returns:
Type
String

equals(obj)

Equality test.

Parameters:
Name Type Description
obj
Overrides:
Returns:
Type
Boolean

equivalent(obj)

Equivalence test.

equivalent() is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.

Parameters:
Name Type Description
obj
Inherited From:
Returns:
Type
Boolean

getAgents( [is] [, batch])

Returns a promise that resolves to the agent list for this Object.

Parameters:
Name Type Argument Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.
batch baja.comm.Batch <optional>

An optional object used to batch network
calls together.
Inherited From:
See:
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getDay()

Return the day (1-31).

Returns:
Type
Number

getIcon()

Return the Object's Icon.

Inherited From:
Returns:
Type
baja.Icon

getJsDate()

Return a new JavaScript Date using this date's year, month and day.

Returns:
Type
Date

getMonth()

Return the month.

When invoking this method, please ensure the baja:Month Type has been
imported.

See:
Returns:

a baja:Month FrozenEnum

Type
baja.FrozenEnum

getType()

Get the type of this instance.

Inherited From:
Returns:
Type
Type

getTypeDisplayName( [cx])

Gets the friendly type display name for this object.

Parameters:
Name Type Argument Description
cx Object <optional>

a context to be passed down to Type
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

getWeekday()

Return the weekday as a baja:Weekday FrozenEnum.

When invoking this method, please ensure the baja:Weekday Type has been
imported.

See:
Returns:

a baja:Weekday FrozenEnum.

Type
baja.FrozenEnum

getYear()

Return the year.

Returns:
Type
Number

isAfter()

Return true if the specified date is after this date.

Parameters:
Name Type Description
date. baja.Date
Returns:
Type
Boolean

isBefore()

Return true if the specified date is before this date.

Parameters:
Name Type Description
date. baja.Date
Returns:
Type
Boolean

make(obj)

Make a Date.

Parameters:
Name Type Description
obj Object

the Object Literal.

Properties
Name Type Argument Description
year Number | baja.Simple <optional>

(any baja:Number type)
month Number | baja.Simple | baja.FrozenEnum <optional>

(any baja:Number
type) (0-11) or a baja:Month FrozenEnum for the month of the year.
day Number | baja.Simple <optional>

(1-31). (any baja:Number type)
jsDate Date <optional>

A JavaScript Date used to specify the year,
month and day. If defined, this will override the year, month and day
arguments.
Overrides:
Returns:
Type
baja.Date
Example
// An Object Literal is used to for the method's arguments...
  var d1 = baja.$("baja:Date").make({
    year: 2008,
    month: baja.$("baja:Month").get("december"),
    day: 24
  });
  // ...or from a JavaScript Date...
  var d2 = baja.$("baja:Date").make({
    jsDate: date
  });

newCopy( [exact])

Every value may be cloned using the newCopy method.

Please note that Simples are immutable so they don't
allocate a new instance.

Parameters:
Name Type Argument Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).
Inherited From:
See:
Returns:

a copy of the value (or the same instance if the value is a
Simple).

toDateString( [obj])

Asynchronously get a String representation of the Date.

This method is invoked asynchronously. A Function callback or an Object
Literal that contains a Function callback must be supplied.

Parameters:
Name Type Argument Description
obj Object <optional>

the Object Literal for the method's arguments.

Properties
Name Type Argument Description
ok function <optional>

(Deprecated: use Promise) the Function callback
that will be invoked once the date has been formatted into a String.
fail function <optional>

(Deprecated: use Promise) the Function
callback that will be invoked if a fatal error occurs whilst formatting the
String.
textPattern String <optional>

the text pattern to use for formatting.
If not specified, then the user's default time format text pattern will be
used.
show Number <optional>

flags used to format the time. For more
information, please see baja.TimeFormat.
Returns:

promise to be resolved with the date string

Type
Promise.<String>
Example
myDate.toDateString().then(function (dateStr) {
    baja.outln("The date is: " + dateStr);
  });

toDateStringSync(obj)

Synchronously get a String representation of the Date.

This method is invoked synchronously. The string result will be returned
directly from this function.

Notes on lexicons:

  • A lexicon will be used if it is passed in.
  • If no lexicon is passed in, the baja lexicon will be used if it has been
    cached locally.
  • If the baja lexicon has not been cached, strings units will be
    represented by their internal tag names (which are in English).
Parameters:
Name Type Description
obj Object

the Object Literal for the method's arguments.

Properties
Name Type Argument Description
textPattern String <optional>

the text pattern to use for formatting.
If not specified, then the user's default time format text pattern will be
used.
show Number <optional>

flags used to format the time. For more
information, please see baja.TimeFormat.
lex <optional>

the baja lexicon
Returns:
Type
String

toString()

Overrides:
See:
  • .toDateStringSync

valueOf()

Overrides:
Returns:

a number that can be compared for sorting (same as JSDate.valeuOf)

Type
Number