HowTo builder

Creates a HowTo and converts string steps to HowToStep entities. The HowTo builder injects @type, validates synchronously, and rejects unknown properties.

Import

// Astro — shown first when Astro is selected
import { HowTo } from '@unschema-graph/astro';

// Svelte 5
import { HowTo } from '@unschema-graph/svelte';

// Core / Node.js
import { HowTo } from '@unschema-graph/core';
import { HowToSchema } from '@unschema-graph/core';

The HowToSchema Zod schema is also exported for composition and advanced validation.

TypeScript types

import {
  HowToSchema,
  type SchemaInput,
  type SchemaOutput,
} from '@unschema-graph/core';

type HowToInput = SchemaInput<typeof HowToSchema>;
type HowToOutput = SchemaOutput<typeof HowToSchema, 'HowTo'>;

Input properties

Property	Input type	Required	Default / constraints
@id	string	No	non-empty
name	string	Yes	non-empty
step	Array<string | object>	Yes	minimum items: 1
description	string	No	—
image	string | ImageObject | Array<string | ImageObject>	No	non-empty
totalTime	string | number | DurationObject	No	non-empty; greater than 0
estimatedCost	string | object	No	—
supply	string | Array | Array	No	—
tool	string | Array | Array	No	—

The aliases above remain the exact authority for nested object types. The builder also accepts a validation configuration as its second argument and always returns @type: 'HowTo'.

Minimal example

import { HowTo } from '@unschema-graph/core';

const entity = HowTo({
  "name": "Deploy an Astro site",
  "step": [
    "Build the site.",
    "Upload the generated files."
  ]
});

Output

{
  "@type": "HowTo",
  "name": "Deploy an Astro site",
  "step": [
    {
      "@type": "HowToStep",
      "text": "Build the site."
    },
    {
      "@type": "HowToStep",
      "text": "Upload the generated files."
    }
  ]
}

Relationships and recipes

• Related builders: Article, BlogPosting, NewsArticle, Recipe
• Used by: no dedicated recipe
• External sources: Schema.org HowTo

Common errors

• Passing an unknown property to the strict builder.
• Using source data that is missing a required property.
• Assuming valid Schema.org guarantees a search appearance.

Validation

Use HowTo.safeParse(input) for external data. If Schema.org supports a property that is not modeled yet, validate the entity first and then use withAdditionalProperties(). Never pass invented properties to the strict builder.