Aller au contenu

FAQPage builder

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

// Astro — shown first when Astro is selected
import { FAQPage } from '@unschema-graph/astro';
// Svelte 5
import { FAQPage } from '@unschema-graph/svelte';
// Core / Node.js
import { FAQPage } from '@unschema-graph/core';
import { FAQPageSchema } from '@unschema-graph/core';

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

import {
FAQPageSchema,
type SchemaInput,
type SchemaOutput,
} from '@unschema-graph/core';
type FAQPageInput = SchemaInput<typeof FAQPageSchema>;
type FAQPageOutput = SchemaOutput<typeof FAQPageSchema, 'FAQPage'>;
Propriété Type d’entrée Obligatoire Valeur par défaut / contraintes
@id string Non non-empty
mainEntity Array Conditionnel —
questions Array Conditionnel —

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

import { FAQPage } from '@unschema-graph/core';
const entity = FAQPage({
"questions": [
{
"question": "What is Astro?",
"answer": "A web framework for content-driven sites."
}
]
});
{
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "What is Astro?",
"acceptedAnswer": {
"@type": "Answer",
"text": "A web framework for content-driven sites."
}
}
]
}
  • 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.

Utilisez FAQPage.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.