Skip to main content
Version: 2.0.x

Namespace: SimpleCalendar

The SimpleCalendar namespace is used to house all functionality that other modules, systems and macros can access for interacting with the Simple Calendar module.

Namespaces

Interfaces

Type Aliases

Date

Ƭ Date: Object

Type representing a date within Simple Calendar

Type declaration

NameTypeDescription
daynumberThe day value of the date. The day is index based, meaning the first day of the month will have a value of 0.
monthnumberThe month value of the date. The month is index based, meaning the first month of a year will have a value of 0.
yearnumberThe year value of the date.

DateChangeOptions

Ƭ DateChangeOptions: Object

Type declaration

NameType
bypassPermissionCheck?boolean
fromCalSync?boolean
save?boolean
showWarning?boolean
sync?boolean
updateApp?boolean
updateMonth?boolean

DateTime

Ƭ DateTime: Date & Time

Type representing a date and time


DateTimeParts

Ƭ DateTimeParts: Partial<Date> & Partial<Time>

Type representing a date and time with optional parameters


Time

Ƭ Time: Object

Type representing a time within Simple Calendar

Type declaration

NameTypeDescription
hournumberThe hour value of the time.
minutenumberThe minute value of the time.
secondsnumberThe second value of the time.