Dataset builder
Le builder Dataset crée une entité Dataset, injecte son @type,
valide les données de manière synchrone et rejette les propriétés inconnues.
// Astro — shown first when Astro is selectedimport { Dataset } from '@unschema-graph/astro';
// Svelte 5import { Dataset } from '@unschema-graph/svelte';
// Core / Node.jsimport { Dataset } from '@unschema-graph/core';import { DatasetSchema } from '@unschema-graph/core';Le schéma Zod DatasetSchema est également exporté pour la composition et la validation avancées.
Types TypeScript
Section intitulée « Types TypeScript »import { DatasetSchema, type SchemaInput, type SchemaOutput,} from '@unschema-graph/core';
type DatasetInput = SchemaInput<typeof DatasetSchema>;type DatasetOutput = SchemaOutput<typeof DatasetSchema, 'Dataset'>;Propriétés d’entrée
Section intitulée « Propriétés d’entrée »| 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 |
url |
string | Non | — |
creator |
string | object | Array<string | object> | Non | — |
distribution |
DataDownload | Array<DataDownload> | Non | — |
license |
string | Non | — |
keywords |
string | Array |
Non | — |
temporalCoverage |
string | Non | — |
spatialCoverage |
string | Non | — |
version |
string | Non | — |
isAccessibleForFree |
boolean | 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 Dataset.
Exemple minimal
Section intitulée « Exemple minimal »import { Dataset } from '@unschema-graph/core';
const entity = Dataset({ "name": "Astro adoption data", "description": "Annual anonymized adoption metrics."});{ "@type": "Dataset", "name": "Astro adoption data", "description": "Annual anonymized adoption metrics."}Relations et recettes
Section intitulée « Relations et recettes »- Builders liés :
Article,BlogPosting,NewsArticle,Recipe - Utilisé par : aucune recette dédiée
- Sources externes : Schema.org Dataset
Erreurs fréquentes
Section intitulée « 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
Section intitulée « Validation »Utilisez Dataset.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.