SerializedCollection
The serialized form CalendaryInstance.toCollection / buildCollection
emit — a Collection whose events are always plain configs, never builders,
matching the .cdy JSON shape. Builders are an input authoring convenience;
serialization compiles them away, so the output type carries no Buildable
and a consumer can read events[i].title without narrowing.
Extends
Section titled “Extends”Omit<Collection,"events">
Properties
Section titled “Properties”$schema?
Section titled “$schema?”
optional$schema?:string
Optional JSON Schema URL for editor/AI validation + autocomplete of the
.cdy document. Point it at the published schema:
"https://calendaryjs.dev/schema/cdy.json". The core ignores it at runtime.
Inherited from
Section titled “Inherited from”collection?
Section titled “collection?”
optionalcollection?:string
Collection name; used as the group id when id is omitted.
Inherited from
Section titled “Inherited from”color?
Section titled “color?”
optionalcolor?:string
Group color, applied to every event that lacks its own (event-level wins).
Inherited from
Section titled “Inherited from”events
Section titled “events”events:
EventConfig[]
optionalid?:string
Group id (defaults to collection, else "collection").
Inherited from
Section titled “Inherited from”
optionalname?:string
Group display name.
Inherited from
Section titled “Inherited from”plugins?
Section titled “plugins?”
optionalplugins?:string[]
Plugin package names the events need — validated on load.
Inherited from
Section titled “Inherited from”priority?
Section titled “priority?”
optionalpriority?:number
Base priority for every event this collection loads that lacks its own
(event-level wins). Overridable at load time via load(cdy, { priority }).
Inherited from
Section titled “Inherited from”version?
Section titled “version?”
optionalversion?:string
Collection version (semver-ish, informational).