Aller au contenu

Course builder

Le builder Course crée une entité Course, 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 { Course } from '@unschema-graph/astro';
// Svelte 5
import { Course } from '@unschema-graph/svelte';
// Core / Node.js
import { Course } from '@unschema-graph/core';
import { CourseSchema } from '@unschema-graph/core';

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

import {
CourseSchema,
type SchemaInput,
type SchemaOutput,
} from '@unschema-graph/core';
type CourseInput = SchemaInput<typeof CourseSchema>;
type CourseOutput = SchemaOutput<typeof CourseSchema, 'Course'>;
Propriété Type d’entrée Obligatoire Valeur par défaut / contraintes
@id string Non non-empty
name string Oui non-empty
description string Oui non-empty
provider string | Person | Organization | LocalBusiness | EntityReference Oui non-empty
courseCode string Non —
educationalCredentialAwarded string Non —
inLanguage string Non —
offers Offer | AggregateOffer | Array<Offer | AggregateOffer> 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 Course.

import { Course } from '@unschema-graph/core';
const entity = Course({
"name": "Astro fundamentals",
"description": "Build content-driven sites with Astro.",
"provider": "Acme Academy"
});
{
"@type": "Course",
"name": "Astro fundamentals",
"description": "Build content-driven sites with Astro.",
"provider": {
"@type": "Organization",
"name": "Acme Academy"
}
}
  • 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 Course.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.