Skip to content

Comment builder

Creates a Comment for discussion and Q&A content. The Comment builder injects @type, validates synchronously, and rejects unknown properties.

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

The CommentSchema Zod schema is also exported for composition and advanced validation.

import {
CommentSchema,
type SchemaInput,
type SchemaOutput,
} from '@unschema-graph/core';
type CommentInput = SchemaInput<typeof CommentSchema>;
type CommentOutput = SchemaOutput<typeof CommentSchema, 'Comment'>;
Property Input type Required Default / constraints
@id string No —
text string Yes non-empty
author string | Person | Organization | EntityReference Yes non-empty
datePublished string | number | Date No non-empty
upvoteCount number No integer; minimum: -9007199254740991; maximum: 9007199254740991

The aliases above remain the exact authority for nested object types. The builder also accepts a validation configuration as its second argument and always returns @type: 'Comment'.

import { Comment } from '@unschema-graph/core';
const entity = Comment({
"text": "This pattern works well.",
"author": "Grace Hopper"
});
{
"@type": "Comment",
"text": "This pattern works well.",
"author": {
"@type": "Person",
"name": "Grace Hopper"
}
}
  • Passing an unknown property to the strict builder.
  • Using source data that is missing a required property.
  • Assuming valid Schema.org guarantees a search appearance.

Use Comment.safeParse(input) for external data. If Schema.org supports a property that is not modeled yet, validate the entity first and then use withAdditionalProperties(). Never pass invented properties to the strict builder.