@livefolio/sdk / SpecialClose

Type Alias: SpecialClose

SpecialClose = object

Defined in: calendars/holiday-rules.ts:37

A year-derived early-close rule consumed by ExchangeCalendar. Follows the same validity bounds and resolve contract as HolidayRule, but instead of marking a day closed entirely it overrides the session close time to closeAt for the matched date.

Properties

closeAt

closeAt: TimeOfDay

Defined in: calendars/holiday-rules.ts:43

The overridden close time in local exchange time.

---

name

name: string

Defined in: calendars/holiday-rules.ts:39

Human-readable name, used for debugging and logging.

---

resolve

resolve: (year) => Date | null

Defined in: calendars/holiday-rules.ts:41

Returns the UTC midnight Date for this early-close day in year, or null to skip.

Parameters

Parameter	Type
year	number

Returns

Date | null

---

validFrom?

optional validFrom?: number

Defined in: calendars/holiday-rules.ts:45

First year (inclusive) this rule applies. Defaults to −∞.

---

validUntil?

optional validUntil?: number

Defined in: calendars/holiday-rules.ts:47

Last year (inclusive) this rule applies. Defaults to +∞.