Class CRHowTo<Type, Shape, Snapshot>

CRDT-backed Schema.org HowTo.

Schema.org: Instructions that explain how to achieve a result.

Type Parameters

Type = "HowTo"
Shape extends CRHowToDefaultShape<Type> = CRHowToDefaultShape<Type>
Snapshot extends Partial<CRStructSnapshot<Shape>> = Partial<CRStructSnapshot<Shape>>

Hierarchy (View Summary)

CRCreativeWork<Type, Shape, Snapshot>
- CRHowTo

Implements

CRHowToState<Type>

Index

Constructors

constructor

new CRHowTo<
    Type = "HowTo",
    Shape extends CRHowToDefaultShape<Type> = CRHowToDefaultShape<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">,
    >,
): CRHowTo<Type, Shape, Snapshot>
Type Parameters
- Type = "HowTo"
- Shape extends CRHowToDefaultShape<Type> = CRHowToDefaultShape<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 CRHowTo<Type, Shape, Snapshot>
Overrides CRCreativeWork.constructor
- Defined in src/CRHowTo/class.ts:36

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

abstract

abstract: Readonly<CRText>

accessibilityAPI

accessibilityAPI: Readonly<CRSet<string>>

accessibilityControl

accessibilityControl: Readonly<CRSet<string>>

accessibilityFeature

accessibilityFeature: Readonly<CRSet<string>>

accessibilityHazard

accessibilityHazard: Readonly<CRSet<string>>

accessibilitySummary

accessibilitySummary: Readonly<CRText>

accessMode

accessMode: Readonly<CRSet<string>>

accessModeSufficient

accessModeSufficient: Readonly<
    CRSet<
        | CRIdReferenceValue
        | CRItemListSnapshot
        | CRTypedIdReferenceValue<"ItemList">,
    >,
>

accountablePerson

accountablePerson: Readonly<CRSet<CRCreativeWorkPerson>>

acquireLicensePage

acquireLicensePage: Readonly<CRSet<CRCreativeWorkReferenceOrURL>>

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

alternativeHeadline

alternativeHeadline: Readonly<CRText>

archivedAt

archivedAt: Readonly<CRSet<CRCreativeWorkArchivedAt>>

assesses

assesses: Readonly<CRSet<CRCreativeWorkDefinedTermText>>

associatedMedia

associatedMedia: Readonly<CRSet<CRCreativeWorkMediaObject>>

audience

audience: Readonly<
CRSet<CRIdReferenceValue | CRTypedIdReferenceValue<"Audience">>,
>

audio

audio: Readonly<CRSet<CRCreativeWorkAudio>>

author

author: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

award

award: Readonly<CRSet<string>>

character

character: Readonly<CRSet<CRCreativeWorkPerson>>

citation

citation: Readonly<CRSet<string | CRCreativeWorkReference>>

comment

comment: Readonly<
CRSet<CRIdReferenceValue | CRTypedIdReferenceValue<"Comment">>,
>

commentCount

commentCount: number

conditionsOfAccess

conditionsOfAccess: Readonly<CRText>

contentLocation

contentLocation: Readonly<CRSet<CRCreativeWorkPlace>>

contentRating

contentRating: Readonly<CRSet<CRCreativeWorkContentRating>>

contentReferenceTime

contentReferenceTime: string

contributor

contributor: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

copyrightHolder

copyrightHolder: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

copyrightNotice

copyrightNotice: Readonly<CRText>

copyrightYear

copyrightYear: number

correction

correction: Readonly<CRSet<CRCreativeWorkCorrection>>

countryOfOrigin

countryOfOrigin: Readonly<
    CRSet<
        | CRIdReferenceValue
        | CRTypedIdReferenceValue<"Country">
        | CRCountrySnapshot,
    >,
>

creativeWorkStatus

creativeWorkStatus: Readonly<CRSet<CRCreativeWorkDefinedTermText>>

creator

creator: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

creditText

creditText: Readonly<CRText>

dateCreated

dateCreated: string

dateModified

dateModified: string

datePublished

datePublished: string

`Readonly`description

description: Readonly<CRText>

Schema.org description: A description of the item.

digitalSourceType

digitalSourceType: Readonly<
    CRSet<
        | CRIdReferenceValue
        | CRTypedIdReferenceValue<"IPTCDigitalSourceEnumeration">,
    >,
>

`Readonly`disambiguatingDescription

disambiguatingDescription: Readonly<CRText>

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

discussionUrl

discussionUrl: string

displayLocation

displayLocation: Readonly<CRSet<CRCreativeWorkPlace>>

editEIDR

editEIDR: Readonly<CRSet<string>>

editor

editor: Readonly<CRSet<CRCreativeWorkPerson>>

educationalAlignment

educationalAlignment: Readonly<
CRSet<CRIdReferenceValue | CRTypedIdReferenceValue<"AlignmentObject">>,
>

educationalLevel

educationalLevel: Readonly<CRSet<CRCreativeWorkDefinedTermTextOrURL>>

educationalUse

educationalUse: Readonly<CRSet<CRCreativeWorkDefinedTermText>>

encoding

encoding: Readonly<CRSet<CRCreativeWorkMediaObject>>

encodingFormat

encodingFormat: Readonly<CRSet<string>>

estimatedCost

estimatedCost: Readonly<CRSet<CRHowToEstimatedCost>>

Schema.org estimatedCost: Estimated cost of the supplies consumed.

exampleOfWork

exampleOfWork: Readonly<CRSet<CRCreativeWorkReference>>

expires

expires: string

`Protected` `Readonly`formatValidators

formatValidators: SchemaCRDTFormatValidators<Shape>

funder

funder: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

funding

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

genre

genre: Readonly<CRSet<CRCreativeWorkDefinedTermTextOrURL>>

hasPart

hasPart: Readonly<CRSet<CRCreativeWorkReference>>

headline

headline: Readonly<CRText>

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

interactionStatistic

interactionStatistic: Readonly<
    CRSet<
        CRIdReferenceValue
        | CRTypedIdReferenceValue<"InteractionCounter">,
    >,
>

interactivityType

interactivityType: Readonly<CRSet<string>>

interpretedAsClaim

interpretedAsClaim: Readonly<
CRSet<CRIdReferenceValue | CRTypedIdReferenceValue<"Claim">>,
>

isAccessibleForFree

isAccessibleForFree: boolean

isBasedOn

isBasedOn: Readonly<CRSet<CRCreativeWorkBasedOn>>

isFamilyFriendly

isFamilyFriendly: boolean

isPartOf

isPartOf: Readonly<CRSet<CRCreativeWorkReferenceOrURL>>

keywords

keywords: Readonly<CRSet<CRCreativeWorkDefinedTermTextOrURL>>

learningResourceType

learningResourceType: Readonly<CRSet<CRCreativeWorkDefinedTermText>>

license

license: Readonly<CRSet<CRCreativeWorkReferenceOrURL>>

locationCreated

locationCreated: Readonly<CRSet<CRCreativeWorkPlace>>

mainEntity

mainEntity: Readonly<CRSet<CRCreativeWorkThing>>

mainEntityOfPage

mainEntityOfPage: Readonly<CRSet<CRThingMainEntityOfPage>>

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

maintainer

maintainer: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

material

material: Readonly<CRSet<CRCreativeWorkProductTextOrURL>>

materialExtent

materialExtent: Readonly<CRSet<CRCreativeWorkMaterialExtent>>

mentions

mentions: Readonly<CRSet<CRCreativeWorkThing>>

`Readonly`name

name: Readonly<CRText>

Schema.org name: The name of the item.

offers

offers: Readonly<CRSet<CRCreativeWorkOffer>>

owner

owner: Readonly<CRSet<CRThingOwner>>

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

pattern

pattern: Readonly<CRSet<CRCreativeWorkDefinedTermText>>

performTime

performTime: string

Schema.org performTime: Time required to perform instructions.

position

position: string | number

potentialAction

potentialAction: Readonly<CRSet<CRThingPotentialAction>>

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

prepTime

prepTime: string

Schema.org prepTime: Time required to prepare the items.

producer

producer: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

provider

provider: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

publication

publication: Readonly<CRSet<CRCreativeWorkPublicationEvent>>

publisher

publisher: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

publisherImprint

publisherImprint: Readonly<CRSet<CRCreativeWorkOrganization>>

publishingPrinciples

publishingPrinciples: Readonly<CRSet<CRCreativeWorkReferenceOrURL>>

recordedAt

recordedAt: Readonly<CRSet<CRCreativeWorkEvent>>

releasedEvent

releasedEvent: Readonly<CRSet<CRCreativeWorkPublicationEvent>>

review

review: Readonly<CRSet<CRCreativeWorkReview>>

`Readonly`sameAs

sameAs: Readonly<CRSet<string>>

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

schemaVersion

schemaVersion: Readonly<CRSet<string>>

sdDatePublished

sdDatePublished: string

sdLicense

sdLicense: Readonly<CRSet<CRCreativeWorkReferenceOrURL>>

sdPublisher

sdPublisher: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

size

size: Readonly<CRSet<CRCreativeWorkSize>>

sourceOrganization

sourceOrganization: Readonly<CRSet<CRCreativeWorkOrganization>>

spatial

spatial: Readonly<CRSet<CRCreativeWorkPlace>>

spatialCoverage

spatialCoverage: Readonly<CRSet<CRCreativeWorkPlace>>

sponsor: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

step

step: Readonly<CRList<CRHowToStepValue>>

Schema.org step: Ordered steps or sections in the instructions.

`Readonly`subjectOf

subjectOf: Readonly<CRSet<CRThingSubjectOf>>

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

supply

supply: Readonly<CRSet<CRHowToSupplyValue>>

Schema.org supply: A supply consumed when performing instructions.

teaches

teaches: Readonly<CRSet<CRCreativeWorkDefinedTermText>>

temporal

temporal: string

temporalCoverage

temporalCoverage: string

text

text: Readonly<CRText>

thumbnail

thumbnail: Readonly<CRSet<CRCreativeWorkThumbnail>>

thumbnailUrl

thumbnailUrl: string

timeRequired

timeRequired: string

tool

tool: Readonly<CRSet<CRHowToToolValue>>

Schema.org tool: An object used when performing instructions.

totalTime

totalTime: string

Schema.org totalTime: Total time required to perform instructions.

translationOfWork

translationOfWork: Readonly<CRSet<CRCreativeWorkReference>>

translator

translator: Readonly<CRSet<CRCreativeWorkPersonOrOrganization>>

typicalAgeRange

typicalAgeRange: string

url

url: string

Schema.org url: URL of the item.

usageInfo

usageInfo: Readonly<CRSet<CRCreativeWorkReferenceOrURL>>

version

version: CRCreativeWorkVersion

video

video: Readonly<CRSet<CRCreativeWorkVideo>>

wordCount

wordCount: number

workExample

workExample: Readonly<CRSet<CRCreativeWorkReference>>

workTranslation

workTranslation: Readonly<CRSet<CRCreativeWorkReference>>

yield

yield: CRHowToYield

Schema.org yield: Quantity that results by performing instructions.

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

acknowledge

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

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

snapshot

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

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

Class CRHowTo<Type, Shape, Snapshot>

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CRHowTo<Type, Shape, Snapshot>

Properties

Readonly@id

Readonly@type

about

abstract

accessibilityAPI

accessibilityControl

accessibilityFeature

accessibilityHazard

accessibilitySummary

accessMode

accessModeSufficient

accountablePerson

acquireLicensePage

ReadonlyadditionalType

aggregateRating

ReadonlyalternateName

alternativeHeadline

archivedAt

assesses

associatedMedia

audience

audio

author

award

character

citation

comment

commentCount

conditionsOfAccess

contentLocation

contentRating

contentReferenceTime

contributor

copyrightHolder

copyrightNotice

copyrightYear

correction

countryOfOrigin

creativeWorkStatus

creator

creditText

dateCreated

dateModified

datePublished

Readonlydescription

digitalSourceType

ReadonlydisambiguatingDescription

discussionUrl

displayLocation

editEIDR

editor

educationalAlignment

educationalLevel

educationalUse

encoding

encodingFormat

estimatedCost

exampleOfWork

expires

Protected ReadonlyformatValidators

funder

funding

genre

hasPart

headline

Readonlyidentifier

`Readonly`@id

`Readonly`@type

`Readonly`additionalType

`Readonly`alternateName

`Readonly`description

`Readonly`disambiguatingDescription

`Protected` `Readonly`formatValidators

`Readonly`identifier

`Readonly`name

`Readonly`sameAs

`Readonly`subjectOf