@mui/internal-docs-infra/useCode/useSourceEnhancing.d.mts

MUI Infra - internal documentation creation tools.

import type { SourceEnhancers, SourceComments, VariantSource } from "../CodeHighlighter/types.mjs";
import type { FallbackNode } from "../CodeHighlighter/fallbackFormat.mjs";
export interface UseSourceEnhancingProps {
  /** The source to enhance (from transformed files or variant) */
  source: VariantSource | null | undefined;
  /** The filename for this source */
  fileName: string | undefined;
  /** Comments extracted from the source (typically from the original variant) */
  comments: SourceComments | undefined;
  /** Array of enhancer functions to apply */
  sourceEnhancers?: SourceEnhancers;
  /** Fallback data for deriving the DEFLATE decompression dictionary */
  fallback?: FallbackNode[];
}
export interface UseSourceEnhancingResult {
  /** The enhanced source */
  enhancedSource: VariantSource | null;
  /** Whether enhancement is currently in progress */
  isEnhancing: boolean;
}
export declare function useSourceEnhancing({
  source,
  fileName,
  comments,
  sourceEnhancers,
  fallback
}: UseSourceEnhancingProps): UseSourceEnhancingResult;