Class ArrayCalendarDatasource<T>

In-memory CalendarDatasource backed by a plain array of events.

Supports add, remove, update, and bulk-replace operations, each of which triggers the changed emitter so the connected view refreshes.

Example

const ds = new ArrayCalendarDatasource<MyPayload>([
  { id: '1', title: 'Standup', start: new Date(2025, 2, 17, 9, 0) },
  { id: '2', title: 'Lunch',   start: new Date(2025, 2, 17, 12, 0), allDay: true },
]);

// Query a date range
const march = ds.getEvents(new Date(2025, 2, 1), new Date(2025, 2, 31));

// Mutate
ds.addEvent({ id: '3', title: 'Review', start: new Date(2025, 2, 18, 14, 0) });
ds.removeEvent('1');

Type Parameters

T = unknown
Optional payload type attached to each event.

Implements

CalendarDatasource<T>

Index

Constructors

constructor

new ArrayCalendarDatasource<T = unknown>(
initialEvents?: readonly CalendarEvent<T>[],
): ArrayCalendarDatasource<T>
Creates an in-memory calendar datasource.
Type Parameters
- T = unknown
  Optional payload type attached to each event.
Parameters
- initialEvents: readonly CalendarEvent<T>[] = []
  Seed events (defensively copied).
Returns ArrayCalendarDatasource<T>
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:39

Properties

`Readonly`changed

changed: Emitter<void> = ...

Emitted whenever the underlying event data changes (add, remove, update, bulk replace).

Accessors

length

get length(): number
Returns the total number of events currently held.

Returns number
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:125

Methods

addEvent

addEvent(event: CalendarEvent<T>): void
Appends an event to the datasource.
Parameters
- event: CalendarEvent<T>
  The event to add.
Returns void
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:67

addEvents

addEvents(events: readonly CalendarEvent<T>[]): void
Appends multiple events at once.
Parameters
- events: readonly CalendarEvent<T>[]
  Events to add.
Returns void
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:77

getAllEvents

getAllEvents(): readonly CalendarEvent<T>[]
Returns all events (snapshot copy).

Returns readonly CalendarEvent<T>[]
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:130

getEvents

getEvents(rangeStart: Date, rangeEnd: Date): readonly CalendarEvent<T>[]
Returns all events whose date range intersects [rangeStart, rangeEnd].

An event intersects the range when:
- event.start <= rangeEnd and
- (event.end ?? event.start) >= rangeStart
Parameters
- rangeStart: Date
  Inclusive start of the query window.
- rangeEnd: Date
  Inclusive end of the query window.
Returns readonly CalendarEvent<T>[]
Implementation of CalendarDatasource.getEvents
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:46

removeEvent

removeEvent(id: string): boolean
Removes an event by its id.
Parameters
- id: string
  The event ID to remove.
Returns boolean
true if an event was removed, false if not found.
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:88

setEvents

setEvents(events: readonly CalendarEvent<T>[]): void
Replaces the entire event set.
Parameters
- events: readonly CalendarEvent<T>[]
  New events (defensively copied).
Returns void
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:119

updateEvent

updateEvent(event: CalendarEvent<T>): void
Replaces an event with a matching id. If no match is found the new event is appended instead.
Parameters
- event: CalendarEvent<T>
  The updated event.
Returns void
- Defined in packages/ui-kit/src/lib/calendar/array-calendar-datasource.ts:104

Class ArrayCalendarDatasource<T>

Example

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ArrayCalendarDatasource<T>

Properties

Readonlychanged

Accessors

length

Returns number

Methods

addEvent

Parameters

Returns void

addEvents

Parameters

Returns void

getAllEvents

Returns readonly CalendarEvent<T>[]

getEvents

Parameters

Returns readonly CalendarEvent<T>[]

removeEvent

Parameters

Returns boolean

setEvents

Parameters

Returns void

updateEvent

Parameters

Returns void

Settings

On This Page

`Readonly`changed