Class CRCreativeWork<Type, Shape, Snapshot>

Readonly@id

ReadonlyadditionalType

ReadonlyalternateName

Readonlydescription

ReadonlydisambiguatingDescription

Readonlyidentifier

image

mainEntityOfPage

Readonlyname

owner

potentialAction

ReadonlysameAs

ReadonlysubjectOf

url

[iterator]

• "[iterator]"(): IterableIterator<[keyof Shape, Shape[keyof Shape]]>

  Iterates over the current live field entries.

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

acknowledge

• acknowledge(): void

  Emits the current acknowledgement frontier for each field.

  Returns void

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

clear

• clear(): void

  Resets every field in the replica back to its default value.

  Returns void

clone

• clone(): Shape

  Returns a cloned plain object view of the current replica fields.

  Returns Shape

  The current field values keyed by field name.

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.

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

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>

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.

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

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

snapshot

• snapshot(): void

  Emits the current serializable snapshot of the replica state.

  Returns void

toJSON

• toJSON(): CRStructSnapshot<Shape>

  Returns the current serializable snapshot projection of this replica.

  Called automatically by JSON.stringify.

  Returns CRStructSnapshot<Shape>

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

toString

• toString(): string

  Attempts to return the current snapshot as a serialized JSON string.

  Returns string

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.

StaticfromJSONLD

• 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>