> ## Documentation Index
> Fetch the complete documentation index at: https://mint-tsdocs.saulo.engineer/llms.txt
> Use this file to discover all available pages before exploring further.

# DocumentationError class

> Base class for all custom errors in the documentation generation process. It extends the native Error class with additional structured context.

export const RefLink = ({target, children}) => {
  if (!target || typeof target !== 'string') {
    console.error('RefLink: Invalid target prop. Expected non-empty string.');
    return <span className="tsdocs-reflink broken-link" title="Invalid RefLink target" data-component="tsdocs-reflink">Invalid Link</span>;
  }
  const linkText = children || target;
  const path = typeof window !== 'undefined' && window.getRefPath ? window.getRefPath(target) : `./${target.split('.').filter(s => s.length > 0).join('/')}`;
  const isValid = typeof window !== 'undefined' && window.VALID_REFS && window.VALID_REFS.has(target);
  const className = !isValid ? 'tsdocs-reflink broken-link' : 'tsdocs-reflink';
  const title = !isValid ? `Broken API reference: ${target}` : undefined;
  return <a href={path} className={className} title={title} data-component="tsdocs-reflink">
      {linkText}
    </a>;
};

export const PageLink = ({target, children}) => {
  if (!target || typeof target !== 'string') {
    console.error('PageLink: Invalid target prop. Expected non-empty string.');
    return <span className="tsdocs-pagelink broken-link" title="Invalid PageLink target" data-component="tsdocs-pagelink">Invalid Link</span>;
  }
  const linkText = children || target;
  let path = target;
  if (!path.startsWith('/')) {
    path = `/${target}`;
  }
  const isValid = typeof window !== 'undefined' && window.VALID_PAGES && window.VALID_PAGES.has(target);
  const className = !isValid ? 'tsdocs-pagelink broken-link' : 'tsdocs-pagelink';
  const title = !isValid ? `Broken page link: ${target}` : undefined;
  return <a href={path} className={className} title={title} data-component="tsdocs-pagelink">
      {linkText}
    </a>;
};

# DocumentationError

## Summary

Base class for all custom errors in the documentation generation process. It extends the native `Error` class with additional structured context.

## Signature

```typescript theme={null}
export declare class DocumentationError extends Error 
```

## Constructors

### constructor

Creates an instance of DocumentationError.

## Properties

### code

**Modifiers**: readonly
**Type**:<RefLink target="mint-tsdocs.ErrorCode">`readonly code: ErrorCode;`</RefLink>
**Default**: \`\`

A standardized, machine-readable error code from the enum. This allows for programmatic handling of different error types.

### context

**Modifiers**: readonly
**Type**:<RefLink target="mint-tsdocs.ErrorContext">`readonly context: ErrorContext;`</RefLink>
**Default**: \`\`

An object containing additional, structured information about the error.

### isUserError

**Modifiers**: readonly
**Type**:`readonly isUserError: boolean;`
**Default**: \`\`

A boolean flag indicating whether the error is likely caused by user input () or by a system/internal failure (). This helps in tailoring the error message to the appropriate audience.

### timestamp

**Modifiers**: readonly
**Type**:`readonly timestamp: Date;`
**Default**: \`\`

The exact time when the error instance was created.

## Methods

### getDetailedMessage

Generates a detailed, multi-line string representation of the error, including all available context.

### toJSON

Converts the error object into a JSON-serializable format, suitable for logging or transmission.

## Events

*No events defined.*