Aller au contenu

DataDownload builder

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

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

import {
DataDownloadSchema,
type SchemaInput,
type SchemaOutput,
} from '@unschema-graph/core';
type DataDownloadInput = SchemaInput<typeof DataDownloadSchema>;
type DataDownloadOutput = SchemaOutput<typeof DataDownloadSchema, 'DataDownload'>;
Propriété Type d’entrée Obligatoire Valeur par défaut / contraintes
@id string Non —
contentUrl string Oui non-empty
encodingFormat string Non —
name string Non —
description 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 DataDownload.

import { DataDownload } from '@unschema-graph/core';
const entity = DataDownload({
"contentUrl": "https://example.com/data.csv",
"encodingFormat": "text/csv"
});
{
"@type": "DataDownload",
"contentUrl": "https://example.com/data.csv",
"encodingFormat": "text/csv"
}
  • 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 DataDownload.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.