Class CREvent<Type, Shape, Snapshot>

CRDT-backed Schema.org Event.

Schema.org: An event happening at a certain time and location.

Type Parameters

Type = "Event"
Shape extends CREventDefaultShape<Type> = CREventDefaultShape<Type>
Snapshot extends Partial<CRStructSnapshot<Shape>> = Partial<CRStructSnapshot<Shape>>

Hierarchy (View Summary)

CRThing<Type, Shape, Snapshot>
- CREvent

Implements

CREventState<Type>

Index

Constructors

constructor

Methods

[iterator] acknowledge addEventListener clear clone entries garbageCollect getCanonicalPresentation keys merge removeEventListener snapshot toJSON toJSONLD toString validateFormat values fromJSONLD

Constructors

constructor

new CREvent<
    Type = "Event",
    Shape extends CREventDefaultShape<Type> = CREventDefaultShape<Type>,
    Snapshot extends
        Partial<CRStructSnapshot<Shape>> = Partial<CRStructSnapshot<Shape>>,
>(
    snapshot?: Snapshot,
    defaultShape?: Partial<Shape>,
    crdtProperties?: Partial<
        Record<Extract<keyof Shape, string>, "map" | "text" | "set" | "list">,
    >,
): CREvent<Type, Shape, Snapshot>
Type Parameters
- Type = "Event"
- Shape extends CREventDefaultShape<Type> = CREventDefaultShape<Type>
- Snapshot extends Partial<CRStructSnapshot<Shape>> = Partial<CRStructSnapshot<Shape>>
Parameters
- Optionalsnapshot: Snapshot
- OptionaldefaultShape: Partial<Shape>
- OptionalcrdtProperties: Partial<Record<Extract<keyof Shape, string>, "map" | "text" | "set" | "list">>
Returns CREvent<Type, Shape, Snapshot>
Overrides CRThing.constructor
- Defined in src/CREvent/class.ts:68

Properties

`Readonly`@id

"@id": string

JSON-LD identifier for this node.

`Readonly`@type

"@type": Type

Schema.org type name for this node.

about

about: Readonly<CRSet<CREventThing>>

actor

actor: Readonly<CRSet<CREventActor>>

`Readonly`additionalType

additionalType: Readonly<CRSet<string>>

Schema.org additionalType: An additional type for the item.

aggregateRating

aggregateRating: Readonly<CRSet<CRIdReferenceValue | CRAggregateRatingSnapshot>>

`Readonly`alternateName

alternateName: Readonly<CRSet<string>>

Schema.org alternateName: An alias for the item.

contributor

contributor: Readonly<CRSet<CREventPersonOrOrganization>>

`Readonly`description

description: Readonly<CRText>

Schema.org description: A description of the item.

director

director: Readonly<CRSet<CREventPerson>>

`Readonly`disambiguatingDescription

disambiguatingDescription: Readonly<CRText>

Schema.org disambiguatingDescription: A short description used to disambiguate the item from other, similar items.

doorTime

doorTime: string

duration

duration: CREventDuration

endDate

endDate: string

eventAttendanceMode

eventAttendanceMode: CREventAttendanceMode

eventSchedule

eventSchedule: Readonly<CRSet<CREventSchedule>>

eventStatus

eventStatus: CREventStatus

`Protected` `Readonly`formatValidators

formatValidators: SchemaCRDTFormatValidators<Shape>

funder

funder: Readonly<CRSet<CREventPersonOrOrganization>>

funding

funding: Readonly<CRSet<CRIdReferenceValue | CRTypedIdReferenceValue<"Grant">>>

hasParticipationOffer

hasParticipationOffer: Readonly<CRSet<CREventOfferOnly>>

hasSponsorshipOffer

hasSponsorshipOffer: Readonly<CRSet<CREventOfferOnly>>

`Readonly`identifier

identifier: Readonly<
    string
    | CRIdReferenceValue
    | CRTypedIdReferenceValue<"PropertyValue">,
>

Schema.org identifier.

image

image: Readonly<CRSet<CRThingImage>>

Schema.org image: An image of the item.

inLanguage

inLanguage: Readonly<CRSet<CREventLanguage>>

isAccessibleForFree

isAccessibleForFree: boolean

keywords

keywords: Readonly<CRSet<CREventKeywords>>

location

location: Readonly<CRSet<CREventLocation>>

mainEntityOfPage

mainEntityOfPage: Readonly<CRSet<CRThingMainEntityOfPage>>

Schema.org mainEntityOfPage: A page or other CreativeWork for which this thing is the main entity being described.

maximumAttendeeCapacity

maximumAttendeeCapacity: number

maximumPhysicalAttendeeCapacity

maximumPhysicalAttendeeCapacity: number

maximumVirtualAttendeeCapacity

maximumVirtualAttendeeCapacity: number

`Readonly`name

name: Readonly<CRText>

Schema.org name: The name of the item.

offers

offers: Readonly<CRSet<CREventOffer>>

organizer

organizer: Readonly<CRSet<CREventPersonOrOrganization>>

owner

owner: Readonly<CRSet<CRThingOwner>>

Schema.org owner: A person or organization who owns this Thing.

performer

performer: Readonly<CRSet<CREventPersonOrOrganization>>

potentialAction

potentialAction: Readonly<CRSet<CRThingPotentialAction>>

Schema.org potentialAction: A potential Action for this Thing.

previousStartDate

previousStartDate: Readonly<CRSet<string>>

recordedIn

recordedIn: Readonly<CRSet<CRIdReferenceValue | CRCreativeWorkSnapshot>>

remainingAttendeeCapacity

remainingAttendeeCapacity: number

review

review: Readonly<CRSet<CREventReview>>

`Readonly`sameAs

sameAs: Readonly<CRSet<string>>

Schema.org sameAs: URL of a reference Web page that unambiguously indicates the item's identity.

sponsor: Readonly<CRSet<CREventPersonOrOrganization>>

startDate

startDate: string

subEvent

subEvent: Readonly<CRSet<CREventReference>>

`Readonly`subjectOf

subjectOf: Readonly<CRSet<CRThingSubjectOf>>

Schema.org subjectOf: A CreativeWork or Event about this Thing.

superEvent

superEvent: Readonly<CRSet<CREventReference>>

translator

translator: Readonly<CRSet<CREventPersonOrOrganization>>

typicalAgeRange

typicalAgeRange: string

url

url: string

Schema.org url: URL of the item.

workFeatured

workFeatured: Readonly<CRSet<CRIdReferenceValue | CRCreativeWorkSnapshot>>

workPerformed

workPerformed: Readonly<CRSet<CRIdReferenceValue | CRCreativeWorkSnapshot>>

Methods

[iterator]

"[iterator]"(): IterableIterator<[keyof Shape, Shape[keyof Shape]]>
Iterates over the current live field entries.

Returns IterableIterator<[keyof Shape, Shape[keyof Shape]]>
Inherited from CRThing.[iterator]
- Defined in src/CRThing/class.ts:850

acknowledge

acknowledge(): void
Emits the current acknowledgement frontier for each field.

Returns void
Inherited from CRThing.acknowledge
- Defined in src/CRThing/class.ts:713

addEventListener

addEventListener<K extends keyof SchemaCRDTEventMap<Shape>>(
    type: K,
    listener: SchemaCRDTEventListenerFor<Shape, K> | null,
    options?: boolean | AddEventListenerOptions,
): void
Registers an event listener.
Type Parameters
- K extends keyof SchemaCRDTEventMap<Shape>
Parameters
- type: K
  The event type to listen for.
- listener: SchemaCRDTEventListenerFor<Shape, K> | null
  The listener to register.
- Optionaloptions: boolean | AddEventListenerOptions
  Listener registration options.
Returns void
Inherited from CRThing.addEventListener
- Defined in src/CRThing/class.ts:863

clear

clear(): void
Resets every field in the replica back to its default value.

Returns void
Inherited from CRThing.clear
- Defined in src/CRThing/class.ts:788

clone

clone(): Shape
Returns a cloned plain object view of the current replica fields.

Returns Shape
The current field values keyed by field name.
Inherited from CRThing.clone
- Defined in src/CRThing/class.ts:799

entries

entries<K extends string | number | symbol>(): [K, Shape[K]][]
Returns cloned key-value pairs for the current replica state.
Type Parameters
- K extends string | number | symbol
Returns [K, Shape[K]][]
The current field entries.
Inherited from CRThing.entries
- Defined in src/CRThing/class.ts:817

garbageCollect

garbageCollect(frontiers: Partial<Record<keyof Shape, string>>[]): void
Removes overwritten identifiers that every provided frontier has acknowledged.
Parameters
- frontiers: Partial<Record<keyof Shape, string>>[]
  A collection of acknowledgement frontiers to compact against.
Returns void
Inherited from CRThing.garbageCollect
- Defined in src/CRThing/class.ts:736

getCanonicalPresentation

getCanonicalPresentation(
options?: SchemaCRDTCanonicalPresentationOptions,
): Promise<string>
Returns canonical N-Quads for signing or hashing the live JSON-LD view.

This canonicalizes the live Schema.org presentation from toJSONLD(). If an application needs to sign the entire CRDT state, canonicalize toJSON() separately at the application protocol layer.
Parameters
- options: SchemaCRDTCanonicalPresentationOptions = {}
Returns Promise<string>
Inherited from CRThing.getCanonicalPresentation
- Defined in src/CRThing/class.ts:612

keys

keys<K extends string | number | symbol>(): K[]
Returns the struct field keys.
Type Parameters
- K extends string | number | symbol
Returns K[]
The field keys in the current replica.
Inherited from CRThing.keys
- Defined in src/CRThing/class.ts:781

merge

merge(
    crStructDelta:
        | Partial<CRStructSnapshot<Shape>>
        | Partial<Record<keyof Shape, unknown>>,
): void
Applies a remote or local delta to the replica state.
Parameters
- crStructDelta: Partial<CRStructSnapshot<Shape>> | Partial<Record<keyof Shape, unknown>>
  The partial serializable field delta to merge.
Returns void
Inherited from CRThing.merge
- Defined in src/CRThing/class.ts:677

removeEventListener

removeEventListener<K extends keyof SchemaCRDTEventMap<Shape>>(
    type: K,
    listener: SchemaCRDTEventListenerFor<Shape, K> | null,
    options?: boolean | EventListenerOptions,
): void
Removes an event listener.
Type Parameters
- K extends keyof SchemaCRDTEventMap<Shape>
Parameters
- type: K
  The event type to stop listening for.
- listener: SchemaCRDTEventListenerFor<Shape, K> | null
  The listener to remove.
- Optionaloptions: boolean | EventListenerOptions
  Listener removal options.
Returns void
Inherited from CRThing.removeEventListener
- Defined in src/CRThing/class.ts:882

snapshot

snapshot(): void
Emits the current serializable snapshot of the replica state.

Returns void
Inherited from CRThing.snapshot
- Defined in src/CRThing/class.ts:768

toJSON

toJSON(): CRStructSnapshot<Shape>
Returns the current serializable snapshot projection of this replica.

Called automatically by JSON.stringify.

Returns CRStructSnapshot<Shape>
Inherited from CRThing.toJSON
- Defined in src/CRThing/class.ts:826

toJSONLD

toJSONLD(options?: SchemaCRDTJSONLDOptions): SchemaCRDTJSONLDDocument
Exports the current live projection as Schema.org JSON-LD.

This does not return CRDT state. toJSON() remains the CRStruct snapshot projection used for replication and persistence.
Parameters
- options: SchemaCRDTJSONLDOptions = {}
Returns SchemaCRDTJSONLDDocument
Inherited from CRThing.toJSONLD
- Defined in src/CRThing/class.ts:581

toString

toString(): string
Attempts to return the current snapshot as a serialized JSON string.

Returns string
Inherited from CRThing.toString
- Defined in src/CRThing/class.ts:832

`Protected`validateFormat

validateFormat(key: Extract<keyof Shape, string>, value: unknown): void
Parameters
- key: Extract<keyof Shape, string>
- value: unknown
Returns void
Inherited from CRThing.validateFormat
- Defined in src/CRThing/class.ts:978

values

values<K extends string | number | symbol>(): Shape[K][]
Returns cloned copies of the current field values.
Type Parameters
- K extends string | number | symbol
Returns Shape[K][]
The current field values.
Inherited from CRThing.values
- Defined in src/CRThing/class.ts:808

`Static`fromJSONLD

fromJSONLD<
    Instance extends
        CRThing<
            "Thing",
            CRThingDefaultShape<"Thing">,
            Partial<CRStructSnapshot<CRThingDefaultShape<"Thing">>>,
        > = CRThing<
        "Thing",
        CRThingDefaultShape<"Thing">,
        Partial<CRStructSnapshot<CRThingDefaultShape<"Thing">>>,
    >,
>(
    document: SchemaCRDTJSONLDInput,
): Promise<Instance>
Constructs a fresh replica from a JSON-LD live presentation.

This is intentionally a constructor-style import, not a CRDT merge path. Use merge() for CRDT snapshots and deltas.
Type Parameters
- Instance extends CRThing<
      "Thing",
      CRThingDefaultShape<"Thing">,
      Partial<CRStructSnapshot<CRThingDefaultShape<"Thing">>>,
  > = CRThing<
      "Thing",
      CRThingDefaultShape<"Thing">,
      Partial<CRStructSnapshot<CRThingDefaultShape<"Thing">>>,
  >
Parameters
- document: SchemaCRDTJSONLDInput
  Compacted or expanded Schema.org JSON-LD document to import.
Returns Promise<Instance>
Inherited from CRThing.fromJSONLD
- Defined in src/CRThing/class.ts:417

Class CREvent<Type, Shape, Snapshot>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CREvent<Type, Shape, Snapshot>

Properties

Readonly@id

Readonly@type

about

actor

ReadonlyadditionalType

aggregateRating

ReadonlyalternateName

attendee

audience

composer

contributor

Readonlydescription

director

ReadonlydisambiguatingDescription

doorTime

duration

endDate

eventAttendanceMode

eventSchedule

eventStatus

Protected ReadonlyformatValidators

funder

funding

hasParticipationOffer

hasSponsorshipOffer

Readonlyidentifier

image

inLanguage

isAccessibleForFree

keywords

location

mainEntityOfPage

maximumAttendeeCapacity

maximumPhysicalAttendeeCapacity

maximumVirtualAttendeeCapacity

Readonlyname

offers

organizer

owner

performer

potentialAction

previousStartDate

recordedIn

remainingAttendeeCapacity

review

ReadonlysameAs

sponsor

startDate

subEvent

ReadonlysubjectOf

superEvent

translator

typicalAgeRange

url

workFeatured

workPerformed

Methods

[iterator]

Returns IterableIterator<[keyof Shape, Shape[keyof Shape]]>

acknowledge

Returns void

addEventListener

Type Parameters

Parameters

Returns void

clear

`Readonly`@id

`Readonly`@type

`Readonly`additionalType

`Readonly`alternateName

`Readonly`description

`Readonly`disambiguatingDescription

`Protected` `Readonly`formatValidators

`Readonly`identifier

`Readonly`name

`Readonly`sameAs

`Readonly`subjectOf

`Protected`validateFormat

`Static`fromJSONLD