JSDoc: o-date

new ODate(rootElement)

Initialise the o-date component.

Methods

• update - (instance) Re-render the formatted date within the `time` element.
• destroy - (instance) Remove o-date from the `time` element i.e. remove event listeners and drop references to the element.
• init(el) - (static) Initialise the o-date component.
• toDate
• format
• getSecondsBetween
• ftTime
• isNearFuture
• isFarFuture
• isToday
• isYesterday
• timeAgo
• asTodayOrYesterdayOrNothing
• timeAgoNoSeconds

Links

• "ODate" class on Github

ODate#update

Instance Method

Re-render the formatted date within the time element.

Returns

• undefined

Links

• "update" function on Github

ODate#destroy

Instance Method

Remove o-date from the time element i.e. remove event listeners and drop references to the element.

Returns

• undefined

Links

• "destroy" function on Github

ODate.init(el)

Static Method

Initialise the o-date component.

Returns

• Array.<ODate> | ODate - - An o-date instance or array of o-date instances.

Links

• "init" function on Github

ODate.toDate

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "toDate" function on Github

ODate.format

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "format" function on Github

ODate.getSecondsBetween

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "getSecondsBetween" function on Github

ODate.ftTime

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "ftTime" function on Github

ODate.isNearFuture

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "isNearFuture" function on Github

ODate.isFarFuture

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "isFarFuture" function on Github

ODate.isToday

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "isToday" function on Github

ODate.isYesterday

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "isYesterday" function on Github

ODate.timeAgo

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "timeAgo" function on Github

ODate.asTodayOrYesterdayOrNothing

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "asTodayOrYesterdayOrNothing" function on Github

ODate.timeAgoNoSeconds

Static Method

Returns

• String - - A formatted date or empty string.

Links

• "timeAgoNoSeconds" function on Github