Packages > pkg.pkl-lang.org/pkl-pantry/icalendar

icalendar.type.Recur0.1.1

Overview
Properties
Methods
Classes
Type Aliases

module icalendar.type.Recur

A recurrence rule.

Module URI:: package://pkg.pkl-lang.org/pkl-pantry/icalendar@0.1.1#/type/Recur.pkl
Source code:: Recur.pkl
Known subtypes:
Known usages:
All versions:

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

dtstart: (DateTime(utc.implies(tzid == null))|Date(tzid == null))?Source
link

tzid: String?Source
link

freq: Frequency Source

The FREQ rule part identifies the type of recurrence rule.
link

interval: Int(this > 0)?Source

The INTERVAL rule part contains a positive integer representing at which intervals the recurrence rule repeats.

Defaults to 1 if not specified.
link

until: (DateTime(dtstart?.ifNonNull((it) -> it is DateTime) ?? true, dtstart?.ifNonNull((it) -> utc == (it as DateTime).utc) ?? true, utc.implies(tzid == null))|Date(dtstart?.ifNonNull((it) -> it is Date) ?? true, tzid == null))?Source

The UNTIL rule part defines a DATE or DATE-TIME value that bounds the recurrence rule in an inclusive manner.

If the value specified by UNTIL is synchronized with the specified recurrence, this DATE or DATE-TIME becomes the last instance of the recurrence. If the "DTSTART" property is specified as a date with local time, then the UNTIL rule part MUST also be specified as a date with local time. If the "DTSTART" property is specified as a date with UTC time or a date with local time and time zone reference, then the UNTIL rule part MUST be specified as a date with UTC time. If not present, and the COUNT rule part is also not present, the "RRULE" is considered to repeat forever.
link

count: Int(this > 0)?(!(this != null && until != null) || throw("count and until may not both be set"))Source

The COUNT rule part defines the number of occurrences at which to range-bound the recurrence.

The "DTSTART" property value always counts as the first occurrence.
link

bysecond: Listing<UInt(isBetween(0, 60))>(!isEmpty, !(dtstart is Date))?Source

The BYSECOND rule part specifies one or more seconds within a minute.
link

byminute: Listing<UInt(isBetween(0, 59))>(!isEmpty, !(dtstart is Date))?Source

The BYMINUTE rule part specifies one or more minutes within an hour.
link

byhour: Listing<UInt(isBetween(0, 23))>(!isEmpty, !(dtstart is Date))?Source

The BYHOUR rule part specifies one or more hours of the day.
link

byday: Listing<(WeekdayString|Weekday((weeknum != null).implies(freq == "MONTHLY" || freq == "YEARLY"), (weeknum != null && freq == "YEARLY").implies(byweekno == null)))>(!isEmpty)?Source

The BYDAY rule part specifies one or more days of the week.

Each BYDAY value can also be preceded by a positive (+n) or negative (-n) integer. If present, this indicates the nth occurrence of a specific day within the MONTHLY or YEARLY "RRULE". For example, within a MONTHLY rule, +1MO (or simply 1MO) represents the first Monday within the month, whereas -1MO represents the last Monday of the month. The numeric value in a BYDAY rule part with the FREQ rule part set to YEARLY corresponds to an offset within the month when the BYMONTH rule part is present, and corresponds to an offset within the year when the BYWEEKNO or BYMONTH rule parts are present.

If an integer modifier is not present, it means all days of this type within the specified frequency. For example, within a MONTHLY rule, MO represents all Mondays within the month.
link

bymonthday: Listing<Int(isBetween(-31, 31), this != 0)>(!isEmpty, freq != "MONTHLY")?Source

The BYMONTHDAY rule part specifies one or more days of the month.

Negative values represent days counting back from the end of a month. For example, -10 represents the tenth to the last day of the month.
link

byyearday: Listing<Int(isBetween(-366, 366), this != 0)>(!isEmpty, freq != "DAILY", freq != "WEEKLY", freq != "MONTHLY")?Source

The BYYEARDAY rule part specifies one or more days of the year.

Negative values represent days counting back from the end of a year. For example, -1 represents the last day of the year (December 31st) and -306 represents the 306th to the last day of the year (March 1st).
link

byweekno: Listing<Int(isBetween(-53, 53), this != 0)>(!isEmpty, freq == "YEARLY")?Source

The BYWEEKNO rule part specifies one or more ordinals specifying weeks of the year.

This corresponds to weeks according to week numbering as defined in ISO.8601.2004. A week is defined as a seven day period, starting on the day of the week defined to be the week start (see wkst). Week number one of the calendar year is the first week that contains at least four (4) days in that calendar year.

Note: Assuming a Monday week start, week 53 can only occur when Thursday is January 1 or if it is a leap year and Wednesday is January 1.
link

bymonth: Listing<UInt(isBetween(1, 12))>(!isEmpty)?Source

The BYMONTH rule part specifies one or more months of the year.
link

wkst: WeekdayString?Source

The WKST rule part specifies the day on which the workweek starts.

This is significant when a WEEKLY "RRULE" has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when in a YEARLY "RRULE" when a BYWEEKNO rule part is specified. Defaults to "MO" if not specified.
link

bysetpos: Listing<Int(isBetween(-366, 366), this != 0)>(!isEmpty, List(bysecond, byminute, byhour, byday, bymonthday, byyearday, byweekno, bymonth) .filterNonNull().length > 0)?Source

The BYSETPOS rule part specifies one or more values that corresponds to the nth occurrence within the set of recurrence instances specified by the rule.

BYSETPOS operates on a set of recurrence instances in one interval of the recurrence rule. For example, in a WEEKLY rule, the interval would be one week A set of recurrence instances starts at the beginning of the interval defined by the FREQ rule part.

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String Source

Serialize the recurrence rule.

Note: this departs from the RFC around line lengths. The 75-character line limit and folding behavior are not enforced. Lines are separated by "\n" (LF) and not "\r\n" (CRLF). Ref: https://datatracker.ietf.org/doc/html/rfc5545#section-3.1
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```

Classes

link

class

Weekday Source

Type Aliases

link

typealias

Frequency = "SECONDLY"|"MINUTELY"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"YEARLY"Source
link

typealias

WeekdayString = "SU"|"MO"|"TU"|"WE"|"TH"|"FR"|"SA"Source