HowToStep builder

Le builder HowToStep crée une entité HowToStep, injecte son @type, valide les données de manière synchrone et rejette les propriétés inconnues.

Import

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

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

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

Le schéma Zod HowToStepSchema est également exporté pour la composition et la validation avancées.

Types TypeScript

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

type HowToStepInput = SchemaInput<typeof HowToStepSchema>;
type HowToStepOutput = SchemaOutput<typeof HowToStepSchema, 'HowToStep'>;

Propriétés d’entrée

Propriété	Type d’entrée	Obligatoire	Valeur par défaut / contraintes
@id	string	Non	—
name	string	Non	—
text	string	Oui	non-empty
image	string | ImageObject	Non	non-empty
url	string	Non	—

Les alias ci-dessus restent la référence exacte, notamment pour les objets imbriqués. Le builder accepte aussi une configuration de validation en second argument et possède une sortie dont le @type vaut toujours HowToStep.

Exemple minimal

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

const entity = HowToStep({
  "text": "Build the Astro project."
});

Sortie

{
  "@type": "HowToStep",
  "text": "Build the Astro project."
}

Relations et recettes

• Builders liés : Article, BlogPosting, NewsArticle, Recipe
• Utilisé par : aucune recette dédiée
• Sources externes : Schema.org HowToStep

Erreurs fréquentes

• Passer une propriété inconnue au builder strict.
• Utiliser une donnée source privée d’une propriété obligatoire.
• Supposer qu’un Schema.org valide garantit un affichage dans la recherche.

Validation

Utilisez HowToStep.safeParse(input) pour les données externes. Pour une extension Schema.org non encore modélisée, validez d’abord l’entité puis utilisez withAdditionalProperties(). N’ajoutez jamais une propriété inventée au builder.