Skip to main content

​
What is TypeInfo?

TypeInfo is an auto-generated JavaScript module that contains structured type information for all documented API items in your project. It provides a convenient way to reference type structures in your documentation with full IDE autocomplete support. When you run mint-tsdocs generate, the tool creates TypeInfo.jsx and TypeInfo.d.ts files in your snippets directory. These files contain all the type information extracted from your TypeScript API in a format compatible with Mintlify’s <TypeTree> component.

​
Why Use TypeInfo?

​
1. IDE Autocomplete

With TypeInfo, you get full autocomplete when referencing types in your documentation: 
import { TypeInfo } from "/snippets/tsdocs/TypeInfo.jsx"

// IDE will suggest all available packages and types
<TypeTree {...TypeInfo.MintTsdocs.IMarkdownDocumenterOptions} />

​
2. Single Source of Truth

Instead of manually maintaining type documentation, TypeInfo is automatically generated from your TypeScript source code. Your documentation stays in sync with your implementation.

​
3. Nested Property Access

TypeInfo includes fully recursive type information, so you can access nested properties: 
import { TypeInfo } from "/snippets/tsdocs/TypeInfo.jsx"

// Access a specific nested property
const templatesConfig = TypeInfo.MintTsdocs.ResolvedConfig.properties.find(
  p => p.name === "templates"
);

​
How to Use TypeInfo

​
Basic Usage with TypeTree

The most common use case is passing TypeInfo directly to the <TypeTree> component: 
import { TypeInfo } from "/snippets/tsdocs/TypeInfo.jsx"

<TypeTree {...TypeInfo.PackageName.TypeName} />
This will render a fully documented type tree with:
  • Property names
  • Type information
  • Descriptions from TSDoc comments
  • Required/optional indicators
  • Default values
  • Deprecated warnings

​
Accessing Individual Properties

You can also extract specific properties for custom documentation: 
import { TypeInfo } from "/snippets/tsdocs/TypeInfo.jsx"

const apiModelProp = TypeInfo.MintTsdocs.IMarkdownDocumenterOptions.properties.find(
  p => p.name === "apiModel"
);

// Use apiModelProp.description, apiModelProp.type, etc.

​
Available Type Information

Each type in TypeInfo includes:
​
name
string
required
The property or type name
​
type
string
required
The TypeScript type (e.g., “string”, “boolean”, “object”)
​
description
string
Description extracted from TSDoc comments
​
required
boolean
Whether the property is required (not optional)
​
deprecated
boolean
Whether the property is marked as deprecated
​
defaultValue
string
The default value from @defaultValue TSDoc tag
​
properties
TypeTreeProperty[]
Nested properties for object types (fully recursive)

​
Exploring Available Types

To see what types are available in your TypeInfo:
  1. Open the generated file: Check docs/snippets/tsdocs/TypeInfo.jsx to browse all available types
  2. Use IDE autocomplete: Start typing TypeInfo. in your MDX file and your IDE will show all available packages
  3. Check the structure: TypeInfo is organized as: 
    TypeInfo.PackageName.TypeName
    Where PackageName is your package name in PascalCase (e.g., “mint-tsdocs” becomes “MintTsdocs”)

​
Import Path Considerations

When importing TypeInfo in MDX files, you may need to use the absolute path /snippets/tsdocs/TypeInfo.jsx instead of a relative path, depending on your file location and Mintlify configuration.
If you encounter import errors, try both: 
// Absolute path (recommended)
import { TypeInfo } from "/snippets/tsdocs/TypeInfo.jsx"

// Relative path (may work depending on location)
import { TypeInfo } from "../snippets/tsdocs/TypeInfo.jsx"

​
Example: Complete Documentation Page

Here’s a complete example showing TypeInfo in action: 
---
title: Configuration Options
description: Complete reference for mint-tsdocs configuration
---

import { TypeInfo } from "/snippets/tsdocs/TypeInfo.jsx"

## Main Configuration

The main configuration object for mint-tsdocs:

<TypeTree {...TypeInfo.MintTsdocs.MintlifyTsDocsConfig} />

## Template Configuration

Detailed template configuration options:

<TypeTree {...TypeInfo.MintTsdocs.ResolvedTemplateConfig} />
TypeInfo is part of a family of auto-generated files that make mint-tsdocs documentation more reliable:
  • TypeInfo (this page) - Provides structured type information for documenting types
  • ValidRefs - Contains all valid API reference IDs for link validation
  • ValidPages - Contains all valid documentation page paths
All three are generated during mint-tsdocs generate and work together to provide type safety and validation throughout your documentation. Learn more in the Link Validation documentation.

​
Best Practices

  1. Always regenerate after API changes: Run mint-tsdocs generate whenever your TypeScript API changes to keep TypeInfo in sync
  2. Use descriptive TSDoc comments: Since TypeInfo extracts descriptions from TSDoc, write comprehensive comments in your source code
  3. Leverage autocomplete: Take advantage of IDE autocomplete by importing TypeInfo at the top of your MDX files
  4. Check for nested properties: Use the properties array to access and document nested object structures
  5. Add to .gitignore: Consider adding docs/snippets/tsdocs/ to your .gitignore if you regenerate docs in CI/CD

TypeTree

Component that renders TypeInfo structures

RefLink

Type-safe API reference links

PageLink

Type-safe documentation page links

Link Validation

How auto-generated validation works

TypeInfo Generation

Deep dive into how TypeInfo is generated

Preview

Styled wrapper for displaying examples