{
  "url": "https://unifast.dev/es/docs/packages/core/overview/",
  "locale": "es",
  "title": "@unifast/core",
  "description": "Definiciones de tipos TypeScript, utilidades HAST y clases de error compartidas entre los paquetes de runtime de unifast",
  "section": "packages",
  "body": "## Visión general\n\n`@unifast/core` proporciona definiciones de tipos TypeScript compartidas para las opciones y resultados de compilación, los nodos HAST (HTML Abstract Syntax Tree), la interfaz de plugins y las clases de error. Es una dependencia de los paquetes de runtime como `@unifast/node`; normalmente **no** necesitas instalarlo directamente.\n\nPara el compilador y los plugins integrados, usa [`@unifast/node`](/docs/packages/node/overview).\n\n## Instalación\n\n## Definiciones de tipos\n\n### CompileOptions\n\nConfiguración para la función `compile()`.\n\n| Propiedad | Tipo | Por defecto | Descripción |\n|----------|------|---------|-------------|\n| `inputKind` | `\"md\" \\| \"mdx\"` | `\"md\"` | Formato de entrada |\n| `outputKind` | `\"html\" \\| \"hast\" \\| \"mdast\" \\| \"mdxJs\"` | `\"html\"` | Formato de salida |\n| `gfm` | `object` | - | Ajustes de GitHub Flavored Markdown |\n| `gfm.tables` | `boolean` | - | Habilitar tablas GFM |\n| `gfm.taskList` | `boolean` | - | Habilitar casillas de listas de tareas |\n| `gfm.strikethrough` | `boolean` | - | Habilitar `~~strikethrough~~` |\n| `gfm.footnotes` | `boolean` | - | Habilitar notas al pie |\n| `gfm.autolink` | `boolean` | - | Habilitar autoenlace de URLs |\n| `frontmatter` | `object` | - | Ajustes de parsing del frontmatter |\n| `frontmatter.yaml` | `boolean` | - | Parsear frontmatter YAML |\n| `frontmatter.toml` | `boolean` | - | Parsear frontmatter TOML |\n| `frontmatter.json` | `boolean` | - | Parsear frontmatter JSON |\n| `rawHtml` | `\"disallow\" \\| \"allowDangerous\" \\| \"parseAndSanitize\"` | - | Cómo tratar el HTML crudo en la fuente |\n| `sanitize` | `object` | - | Ajustes de sanitización de HTML |\n| `sanitize.enabled` | `boolean` | - | Habilitar la sanitización |\n| `sanitize.schema` | `SanitizeSchema` | - | Reglas de sanitización personalizadas |\n| `highlight` | `object` | - | Ajustes de resaltado de sintaxis |\n| `highlight.enabled` | `boolean` | - | Habilitar el resaltado de sintaxis |\n| `highlight.engine` | `\"none\" \\| \"syntect\" \\| \"treeSitter\"` | - | Motor de resaltado |\n| `slug` | `object` | - | Ajustes de generación de slugs de encabezado |\n| `slug.mode` | `\"github\" \\| \"unicode\"` | - | Algoritmo de generación de slugs |\n| `toc` | `object` | - | Ajustes de tabla de contenidos |\n| `toc.enabled` | `boolean` | - | Habilitar la extracción de TOC |\n| `toc.maxDepth` | `number` | - | Profundidad máxima de encabezado a incluir |\n| `diagnostics` | `object` | - | Ajustes de salida de diagnósticos |\n| `diagnostics.format` | `\"compact\" \\| \"verbose\"` | - | Formato de diagnóstico |\n| `cache` | `object` | - | Ajustes de caché |\n| `cache.enabled` | `boolean` | - | Habilitar el caché de resultados |\n| `cache.dir` | `string` | - | Ruta del directorio de caché |\n| `plugins` | `UnifastPlugin[]` | `[]` | Array de plugins a aplicar |\n\n### CompileResult\n\nRetornado por la función `compile()`.\n\n| Propiedad | Tipo | Descripción |\n|----------|------|-------------|\n| `output` | `string \\| object` | Salida compilada (cadena HTML, JSON HAST o JSON MDAST dependiendo de `outputKind`) |\n| `frontmatter` | `Record<string, unknown>` | Metadatos del frontmatter parseados |\n| `diagnostics` | `Diagnostic[]` | Array de avisos y errores |\n| `stats` | `{ parseMs, transformMs, emitMs }` | Desglose de tiempos en milisegundos |\n| `toc` | `TocEntry[]` | Entradas de la tabla de contenidos extraída |\n\n### Diagnostic\n\n| Propiedad | Tipo | Descripción |\n|----------|------|-------------|\n| `level` | `\"error\" \\| \"warn\"` | Nivel de severidad |\n| `message` | `string` | Mensaje legible para humanos |\n| `start` | `number \\| undefined` | Desplazamiento inicial en bytes dentro de la fuente |\n| `end` | `number \\| undefined` | Desplazamiento final en bytes dentro de la fuente |\n| `line` | `number \\| undefined` | Número de línea (empezando en 1) |\n| `column` | `number \\| undefined` | Número de columna (empezando en 1) |\n\n### TocEntry\n\nUn único encabezado extraído para la tabla de contenidos.\n\n| Propiedad | Tipo | Descripción |\n|----------|------|-------------|\n| `depth` | `number` | Nivel del encabezado (1-6) |\n| `text` | `string` | Contenido de texto plano del encabezado |\n| `slug` | `string` | Slug generado para el enlace de anclaje |\n\n### SanitizeSchema\n\nReglas de sanitización personalizadas.\n\n| Propiedad | Tipo | Descripción |\n|----------|------|-------------|\n| `allowedTags` | `string[]` | Etiquetas HTML permitidas |\n| `allowedAttributes` | `Record<string, string[]>` | Atributos permitidos por etiqueta |\n| `allowedProtocols` | `Record<string, string[]>` | Protocolos de URL permitidos por atributo |\n\n### UnifastPlugin\n\nLa interfaz de plugin para extender unifast.\n\n| Propiedad | Tipo | Descripción |\n|----------|------|-------------|\n| `name` | `string` | Nombre único del plugin |\n| `options?` | `Partial<CompileOptions>` | Opciones a combinar con las opciones de compilación |\n| `hastTransform?` | `(hast: HastRoot) => HastRoot` | Transforma el árbol HAST después de la compilación |\n\n### Tipos de nodo HAST\n\n| Tipo | Campo `type` | Propiedades | Descripción |\n|------|-------------|------------|-------------|\n| `HastRoot` | `\"root\"` | `children: HastNode[]` | Nodo raíz del árbol |\n| `HastElement` | `\"element\"` | `tagName`, `properties`, `children` | Un elemento HTML |\n| `HastText` | `\"text\"` | `value: string` | Un nodo de texto |\n| `HastRaw` | `\"raw\"` | `value: string` | HTML crudo sin procesar |\n| `HastComment` | `\"comment\"` | `value: string` | Un comentario HTML |\n| `HastDoctype` | `\"doctype\"` | - | Un nodo `<!DOCTYPE html>` |\n\n`HastNode` es el tipo unión: `HastRoot | HastElement | HastText | HastRaw | HastComment | HastDoctype`\n\n## Clases de error\n\n| Clase | Extiende | Propiedades | Descripción |\n|-------|---------|------------|-------------|\n| `UnifastError` | `Error` | `code?: string`, `span?: { start, end }` | Clase de error base para todos los errores de unifast |\n| `ParseError` | `UnifastError` | `code: \"PARSE_ERROR\"` | Se lanza cuando la entrada Markdown/MDX no puede parsearse |\n| `CompileError` | `UnifastError` | `code: \"COMPILE_ERROR\"` | Se lanza cuando la compilación falla después del parsing |\n\n```ts\n\ntry {\n  // ... compile something\n} catch (err) {\n  if (err instanceof ParseError) {\n    console.error(`Parse error at ${err.span?.start}: ${err.message}`);\n  } else if (err instanceof CompileError) {\n    console.error(`Compile error: ${err.message}`);\n  }\n}\n```\n\n## Resumen de exports\n\n| Export | Tipo | Descripción |\n|--------|------|-------------|\n| `CompileOptions` | type | Configuración de compilación |\n| `CompileResult` | type | Resultado de compilación |\n| `TocEntry` | type | Entrada de tabla de contenidos |\n| `SanitizeSchema` | type | Reglas de sanitización |\n| `UnifastPlugin` | type | Interfaz de plugin |\n| `HastNode` | type | Unión de todos los tipos de nodo HAST |\n| `HastRoot` | type | Nodo raíz HAST |\n| `HastElement` | type | Nodo de elemento HAST |\n| `HastText` | type | Nodo de texto HAST |\n| `HastRaw` | type | Nodo de HTML crudo HAST |\n| `HastComment` | type | Nodo de comentario HAST |\n| `HastDoctype` | type | Nodo de doctype HAST |\n| `hastToHtml` | function | Serializador de HAST a HTML |\n| `escapeHtml` | function | Escapa caracteres especiales de HTML (`&`, `<`, `>`, `\"`) |\n| `extractLang` | function | Extrae el identificador de lenguaje de un elemento HAST `<code>` |\n| `extractText` | function | Extrae el contenido de texto plano de un nodo HAST |\n| `findCodeChild` | function | Encuentra el elemento hijo `<code>` dentro de un elemento `<pre>` |\n| `visitHast` | function | Utilidad con patrón visitor para recorrer árboles HAST |\n| `UnifastError` | class | Clase de error base |\n| `ParseError` | class | Clase de error de parseo |\n| `CompileError` | class | Clase de error de compilación |",
  "alternates": [
    {
      "locale": "en",
      "url": "https://unifast.dev/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/docs/packages/core/overview.json"
    },
    {
      "locale": "ja",
      "url": "https://unifast.dev/ja/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ja/docs/packages/core/overview.json"
    },
    {
      "locale": "zh-CN",
      "url": "https://unifast.dev/zh-CN/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/zh-CN/docs/packages/core/overview.json"
    },
    {
      "locale": "zh-TW",
      "url": "https://unifast.dev/zh-TW/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/zh-TW/docs/packages/core/overview.json"
    },
    {
      "locale": "ko",
      "url": "https://unifast.dev/ko/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ko/docs/packages/core/overview.json"
    },
    {
      "locale": "fr",
      "url": "https://unifast.dev/fr/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/fr/docs/packages/core/overview.json"
    },
    {
      "locale": "it",
      "url": "https://unifast.dev/it/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/it/docs/packages/core/overview.json"
    },
    {
      "locale": "es",
      "url": "https://unifast.dev/es/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/es/docs/packages/core/overview.json"
    },
    {
      "locale": "pt-BR",
      "url": "https://unifast.dev/pt-BR/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/pt-BR/docs/packages/core/overview.json"
    },
    {
      "locale": "de",
      "url": "https://unifast.dev/de/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/de/docs/packages/core/overview.json"
    },
    {
      "locale": "ru",
      "url": "https://unifast.dev/ru/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/ru/docs/packages/core/overview.json"
    },
    {
      "locale": "hi",
      "url": "https://unifast.dev/hi/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/hi/docs/packages/core/overview.json"
    },
    {
      "locale": "id",
      "url": "https://unifast.dev/id/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/id/docs/packages/core/overview.json"
    },
    {
      "locale": "tr",
      "url": "https://unifast.dev/tr/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/tr/docs/packages/core/overview.json"
    },
    {
      "locale": "vi",
      "url": "https://unifast.dev/vi/docs/packages/core/overview/",
      "api": "https://unifast.dev//api/vi/docs/packages/core/overview.json"
    }
  ]
}