Class CRHowToItem<Type, Shape, Snapshot>

CRDT-backed Schema.org HowToItem.

Schema.org: An item used as either a tool or supply when performing instructions.

Type Parameters

Type = "HowToItem"
Shape extends CRHowToItemDefaultShape<Type> = CRHowToItemDefaultShape<Type>
Snapshot extends Partial<CRStructSnapshot<Shape>> = Partial<CRStructSnapshot<Shape>>

Hierarchy (View Summary)

CRListItem<Type, Shape, Snapshot>
- CRHowToItem
  - CRHowToSupply
  - CRHowToTool

Implements

CRHowToItemState<Type>

Constructors

constructor

new CRHowToItem<
    Type = "HowToItem",
    Shape extends CRHowToItemDefaultShape<Type> = CRHowToItemDefaultShape<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">,
    >,
): CRHowToItem<Type, Shape, Snapshot>
Type Parameters
- Type = "HowToItem"
- Shape extends CRHowToItemDefaultShape<Type> = CRHowToItemDefaultShape<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 CRHowToItem<Type, Shape, Snapshot>
Overrides CRListItem.constructor
- Defined in src/CRHowToItem/class.ts:35

Properties

`Readonly`@id

"@id": string

JSON-LD identifier for this node.

`Readonly`@type

"@type": Type

Schema.org type name for this node.

`Readonly`additionalType

additionalType: Readonly<CRSet<string>>

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

`Readonly`alternateName

alternateName: Readonly<CRSet<string>>

Schema.org alternateName: An alias for the item.

`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.

`Protected` `Readonly`formatValidators

formatValidators: SchemaCRDTFormatValidators<Shape>

`Readonly`identifier

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

Schema.org identifier.

image

image: Readonly<CRSet<CRThingImage>>

Schema.org image: An image of the item.

item

item: CRListItemItem

Schema.org item: An entity represented by an entry in a list or data feed.

mainEntityOfPage

mainEntityOfPage: Readonly<CRSet<CRThingMainEntityOfPage>>

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

`Readonly`name

name: Readonly<CRText>

Schema.org name: The name of the item.

nextItem

nextItem: CRListItemRelation

Schema.org nextItem: A link to the ListItem that follows the current one.

owner

owner: Readonly<CRSet<CRThingOwner>>

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

position

position: CRListItemPosition

Schema.org position: The position of an item in a series or sequence.

potentialAction

potentialAction: Readonly<CRSet<CRThingPotentialAction>>

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

previousItem

previousItem: CRListItemRelation

Schema.org previousItem: A link to the ListItem that precedes the current one.

requiredQuantity

requiredQuantity: CRHowToItemRequiredQuantity

Schema.org requiredQuantity: The required quantity of the item(s).

`Readonly`sameAs

sameAs: Readonly<CRSet<string>>

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

`Readonly`subjectOf

subjectOf: Readonly<CRSet<CRThingSubjectOf>>

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

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 CRListItem.[iterator]
- Defined in src/CRThing/class.ts:850

acknowledge

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

Returns void
Inherited from CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.removeEventListener
- Defined in src/CRThing/class.ts:882

snapshot

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

Returns void
Inherited from CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.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 CRListItem.fromJSONLD
- Defined in src/CRThing/class.ts:417

Class CRHowToItem<Type, Shape, Snapshot>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CRHowToItem<Type, Shape, Snapshot>

Properties

Readonly@id

Readonly@type

ReadonlyadditionalType

ReadonlyalternateName

Readonlydescription

ReadonlydisambiguatingDescription

Protected ReadonlyformatValidators

Readonlyidentifier

image

item

mainEntityOfPage

Readonlyname

nextItem

owner

position

potentialAction

previousItem

requiredQuantity

ReadonlysameAs

ReadonlysubjectOf

url

Methods

[iterator]

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

acknowledge

Returns void

addEventListener

Type Parameters

Parameters

Returns void

clear

Returns void

clone

Returns Shape

entries

Type Parameters

Returns [K, Shape[K]][]

garbageCollect

Parameters

Returns void

getCanonicalPresentation

Parameters

Returns Promise<string>

keys

Type Parameters

Returns K[]

merge

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

snapshot

Returns void

toJSON

Returns CRStructSnapshot<Shape>

toJSONLD

Parameters

Returns SchemaCRDTJSONLDDocument

toString

Returns string

ProtectedvalidateFormat

Parameters

Returns void

values

`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