Back to Nextra

Example Tsdoc

docs/components/example-tsdoc.mdx

2.0.0-beta.6474 B
Original Source
ts
type Example = {
  /**
   * **Foo** description.
   * @default "dimaMachina"
   * @remarks `"not dimaMachina"`
   */
  foo: string
}

In this example, while the actual type of the property foo is string, the displayed type will be "not dimaMachina" as per the @remarks tag.

<APIDocs code={` type Example = { /**

  • Foo description.
  • @default "dimaMachina"
  • @remarks `"not dimaMachina"` */ foo: string } export default Example`} />