Index of every page on this site: llms.txt
Unhead
TypeScript
Schema

Comment Schema

Copy for LLMs
On this page

Schema.org Comment

  • Type: defineComment<T extends Record<string, any>>(input?: Comment & T)
    Describes a comment, usually in the context of an Article or WebPage.

Useful Links

Required properties

  • text string
    Content of the comment.
  • author Person
    The registered author is moved to a root Schema node, resolving the field as an @id reference to a Person.

Defaults

  • @type: Comment
  • @id: ${canonicalUrl}#/schema/comment/{n}
  • about: Article reference

Resolves

  • author is resolved as a root Person node and replaced with an ID reference
  • dateCreated and dateModified accept Date objects and are serialized as ISO 8601 strings

Examples

See the blog recipe for more examples.

Minimal

defineComment({
  text: 'The setup guide answered my question.',
  author: {
    name: 'Harlan Wilton',
    url: 'https://harlanzw.com',
  }
})

Types

export interface CommentSimple extends Thing {
  /**
   * The textual content of the comment, stripping HTML tags.
   */
  text: string
  /**
   *  A reference by ID to the parent Article (or WebPage, when no Article is present).
   */
  about?: IdReference
  /**
   * A reference by ID to the Person who wrote the comment.
   */
  author: NodeRelation<Person>
  /**
   * The date and time the comment was created.
   */
  dateCreated?: ResolvableDate
  /**
   * The date and time the comment was last modified.
   */
  dateModified?: ResolvableDate
  /**
   * The number of upvotes the comment has received.
   */
  upvoteCount?: number
  /**
   * The number of downvotes the comment has received.
   */
  downvoteCount?: number
}

Related Schemas

Edit this page
Markdown For LLMs
Did this page help you?

Breadcrumb Schema

Use defineBreadcrumb() to add BreadcrumbList structured data that describes a page's position in the site hierarchy.

Course Schema

Use defineCourse() to add Course structured data with a provider, description, and course details.