Skip to content

SeeData

Represents the parsed result of @see tags in JSDoc. Used to provide references to external documents or related content.

Signature

typescript
interface SeeData {
  reference: string;
  description?: string;
}

Properties

  • referenceRequired · string

    URL or link to the external document to reference

  • description · string

    Optional description for the reference

Released under the MIT License.