HowToStep builder
Creates a reusable HowToStep entity. The HowToStep builder injects @type, validates synchronously, and
rejects unknown properties.
Import
Section titled “Import”// Astro — shown first when Astro is selectedimport { HowToStep } from '@unschema-graph/astro';
// Svelte 5import { HowToStep } from '@unschema-graph/svelte';
// Core / Node.jsimport { HowToStep } from '@unschema-graph/core';import { HowToStepSchema } from '@unschema-graph/core';The HowToStepSchema Zod schema is also exported for composition and advanced validation.
TypeScript types
Section titled “TypeScript types”import { HowToStepSchema, type SchemaInput, type SchemaOutput,} from '@unschema-graph/core';
type HowToStepInput = SchemaInput<typeof HowToStepSchema>;type HowToStepOutput = SchemaOutput<typeof HowToStepSchema, 'HowToStep'>;Input properties
Section titled “Input properties”| Property | Input type | Required | Default / constraints |
|---|---|---|---|
@id |
string | No | — |
name |
string | No | — |
text |
string | Yes | non-empty |
image |
string | ImageObject | No | non-empty |
url |
string | 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: 'HowToStep'.
Minimal example
Section titled “Minimal example”import { HowToStep } from '@unschema-graph/core';
const entity = HowToStep({ "text": "Build the Astro project."});Output
Section titled “Output”{ "@type": "HowToStep", "text": "Build the Astro project."}Relationships and recipes
Section titled “Relationships and recipes”- Related builders:
Article,BlogPosting,NewsArticle,Recipe - Used by: no dedicated recipe
- External sources: Schema.org HowToStep
Common errors
Section titled “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
Section titled “Validation”Use HowToStep.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.