Class CRPlace<Type, Shape, Snapshot>

CRDT-backed Schema.org Thing.

Schema.org: The most generic type of item.

Type Parameters

Type = "Place"
Shape extends CRPlaceDefaultShape<Type> = CRPlaceDefaultShape<Type>
Snapshot extends Partial<CRStructSnapshot<Shape>> = Partial<CRStructSnapshot<Shape>>

Hierarchy (View Summary)

CRThing<Type, Shape, Snapshot>
- CRPlace
  - CRAdministrativeArea

Implements

CRPlaceState<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 CRPlace<
    Type = "Place",
    Shape extends CRPlaceDefaultShape<Type> = CRPlaceDefaultShape<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">,
    >,
): CRPlace<Type, Shape, Snapshot>
Type Parameters
- Type = "Place"
- Shape extends CRPlaceDefaultShape<Type> = CRPlaceDefaultShape<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 CRPlace<Type, Shape, Snapshot>
Overrides CRThing.constructor
- Defined in src/CRPlace/class.ts:65

Properties

`Readonly`@id

"@id": string

JSON-LD identifier for this node.

`Readonly`@type

"@type": Type

Schema.org type name for this node.

additionalProperty

additionalProperty: Readonly<CRSet<CRPlaceAdditionalProperty>>

`Readonly`additionalType

additionalType: Readonly<CRSet<string>>

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

address

address: Readonly<CRSet<CRPlaceAddress>>

aggregateRating

aggregateRating: Readonly<CRSet<CRPlaceAggregateRating>>

`Readonly`alternateName

alternateName: Readonly<CRSet<string>>

Schema.org alternateName: An alias for the item.

amenityFeature

amenityFeature: Readonly<CRSet<CRPlaceAmenityFeature>>

branchCode

branchCode: string

containedInPlace

containedInPlace: Readonly<CRSet<CRPlaceRelation>>

containsPlace

containsPlace: Readonly<CRSet<CRPlaceRelation>>

`Readonly`description

description: Readonly<CRText>

Schema.org description: A description of the item.

`Readonly`disambiguatingDescription

disambiguatingDescription: Readonly<CRText>

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

event

event: Readonly<CRSet<CRPlaceEvent>>

faxNumber

faxNumber: string

`Protected` `Readonly`formatValidators

formatValidators: SchemaCRDTFormatValidators<Shape>

geo

geo: Readonly<CRSet<CRPlaceGeo>>

geoContains

geoContains: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoCoveredBy

geoCoveredBy: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoCovers

geoCovers: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoCrosses

geoCrosses: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoDisjoint

geoDisjoint: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoEquals

geoEquals: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoIntersects

geoIntersects: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoOverlaps

geoOverlaps: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoTouches

geoTouches: Readonly<CRSet<CRGeospatialGeometryRelation>>

geoWithin

geoWithin: Readonly<CRSet<CRGeospatialGeometryRelation>>

globalLocationNumber

globalLocationNumber: string

hasCertification

hasCertification: Readonly<
    CRSet<
        string
        | CRIdReferenceValue
        | CRTypedIdReferenceValue<"Certification">,
    >,
>

hasDriveThroughService

hasDriveThroughService: boolean

hasGS1DigitalLink

hasGS1DigitalLink: string

hasMap

hasMap: Readonly<CRSet<CRPlaceMap>>

`Readonly`identifier

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

Schema.org identifier.

image

image: Readonly<CRSet<CRThingImage>>

Schema.org image: An image of the item.

isAccessibleForFree

isAccessibleForFree: boolean

isicV4

isicV4: string

keywords

keywords: Readonly<CRSet<string | CRIdReferenceValue | CRDefinedTermSnapshot>>

latitude

latitude: string

logo

logo: Readonly<CRSet<CRPlaceImage>>

longitude

longitude: string

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

`Readonly`name

name: Readonly<CRText>

Schema.org name: The name of the item.

openingHoursSpecification

openingHoursSpecification: Readonly<CRSet<CRPlaceOpeningHoursSpecification>>

owner

owner: Readonly<CRSet<CRThingOwner>>

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

photo

photo: Readonly<CRSet<CRPlaceImage>>

potentialAction

potentialAction: Readonly<CRSet<CRThingPotentialAction>>

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

publicAccess

publicAccess: boolean

review

review: Readonly<CRSet<CRPlaceReview>>

`Readonly`sameAs

sameAs: Readonly<CRSet<string>>

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

slogan

slogan: Readonly<CRText>

smokingAllowed

smokingAllowed: boolean

specialOpeningHoursSpecification

specialOpeningHoursSpecification: Readonly<
CRSet<CRPlaceOpeningHoursSpecification>,
>

`Readonly`subjectOf

subjectOf: Readonly<CRSet<CRThingSubjectOf>>

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

telephone

telephone: string

tourBookingPage

tourBookingPage: string

url

url: string

Schema.org url: URL of the item.

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 CRPlace<Type, Shape, Snapshot>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CRPlace<Type, Shape, Snapshot>

Properties

Readonly@id

Readonly@type

additionalProperty

ReadonlyadditionalType

address

aggregateRating

ReadonlyalternateName

amenityFeature

branchCode

containedInPlace

containsPlace

Readonlydescription

ReadonlydisambiguatingDescription

event

faxNumber

Protected ReadonlyformatValidators

geo

geoContains

geoCoveredBy

geoCovers

geoCrosses

geoDisjoint

geoEquals

geoIntersects

geoOverlaps

geoTouches

geoWithin

globalLocationNumber

hasCertification

hasDriveThroughService

hasGS1DigitalLink

hasMap

Readonlyidentifier

image

isAccessibleForFree

isicV4

keywords

latitude

logo

longitude

mainEntityOfPage

maximumAttendeeCapacity

Readonlyname

openingHoursSpecification

owner

photo

potentialAction

publicAccess

review

ReadonlysameAs

slogan

smokingAllowed

specialOpeningHoursSpecification

ReadonlysubjectOf

telephone

tourBookingPage

url

Methods

[iterator]

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

acknowledge

Returns void

addEventListener

Type Parameters

Parameters

Returns void

`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