{
  "url": "https://unifast.dev/pt-BR/docs/packages/core/overview/",
  "locale": "pt-BR",
  "title": "@unifast/core",
  "description": "Definições de tipos TypeScript, utilitários HAST e classes de erro compartilhadas entre os pacotes de runtime do unifast",
  "section": "packages",
  "body": "## Visão Geral\n\nO `@unifast/core` fornece definições de tipos TypeScript compartilhadas para opções de compilação, resultados, nós HAST (HTML Abstract Syntax Tree), a interface de plugin e classes de erro. Ele é uma dependência de pacotes de runtime como o `@unifast/node` — você normalmente **não** precisa instalá-lo diretamente.\n\nPara o compilador e os plugins integrados, use [`@unifast/node`](/docs/packages/node/overview).\n\n## Instalação\n\n## Definições de Tipos\n\n### CompileOptions\n\nConfiguração para a função `compile()`.\n\n| Propriedade | Tipo | Padrão | Descrição |\n|----------|------|---------|-------------|\n| `inputKind` | `\"md\" \\| \"mdx\"` | `\"md\"` | Formato de entrada |\n| `outputKind` | `\"html\" \\| \"hast\" \\| \"mdast\" \\| \"mdxJs\"` | `\"html\"` | Formato de saída |\n| `gfm` | `object` | - | Configurações do GitHub Flavored Markdown |\n| `gfm.tables` | `boolean` | - | Habilita tabelas GFM |\n| `gfm.taskList` | `boolean` | - | Habilita checkboxes de task list |\n| `gfm.strikethrough` | `boolean` | - | Habilita `~~strikethrough~~` |\n| `gfm.footnotes` | `boolean` | - | Habilita footnotes |\n| `gfm.autolink` | `boolean` | - | Habilita auto-linking de URLs |\n| `frontmatter` | `object` | - | Configurações de parsing de frontmatter |\n| `frontmatter.yaml` | `boolean` | - | Faz parse de frontmatter YAML |\n| `frontmatter.toml` | `boolean` | - | Faz parse de frontmatter TOML |\n| `frontmatter.json` | `boolean` | - | Faz parse de frontmatter JSON |\n| `rawHtml` | `\"disallow\" \\| \"allowDangerous\" \\| \"parseAndSanitize\"` | - | Como tratar HTML bruto na fonte |\n| `sanitize` | `object` | - | Configurações de sanitização de HTML |\n| `sanitize.enabled` | `boolean` | - | Habilita sanitização |\n| `sanitize.schema` | `SanitizeSchema` | - | Regras de sanitização customizadas |\n| `highlight` | `object` | - | Configurações de syntax highlighting |\n| `highlight.enabled` | `boolean` | - | Habilita syntax highlighting |\n| `highlight.engine` | `\"none\" \\| \"syntect\" \\| \"treeSitter\"` | - | Engine de highlighting |\n| `slug` | `object` | - | Configurações de geração de slug de heading |\n| `slug.mode` | `\"github\" \\| \"unicode\"` | - | Algoritmo de geração de slug |\n| `toc` | `object` | - | Configurações de table of contents |\n| `toc.enabled` | `boolean` | - | Habilita extração de TOC |\n| `toc.maxDepth` | `number` | - | Profundidade máxima de heading a incluir |\n| `diagnostics` | `object` | - | Configurações de saída de diagnóstico |\n| `diagnostics.format` | `\"compact\" \\| \"verbose\"` | - | Formato de diagnóstico |\n| `cache` | `object` | - | Configurações de cache |\n| `cache.enabled` | `boolean` | - | Habilita cache de resultados |\n| `cache.dir` | `string` | - | Caminho do diretório de cache |\n| `plugins` | `UnifastPlugin[]` | `[]` | Array de plugins a aplicar |\n\n### CompileResult\n\nRetornado pela função `compile()`.\n\n| Propriedade | Tipo | Descrição |\n|----------|------|-------------|\n| `output` | `string \\| object` | Saída compilada (string HTML, JSON HAST ou JSON MDAST dependendo de `outputKind`) |\n| `frontmatter` | `Record<string, unknown>` | Metadados de frontmatter parseados |\n| `diagnostics` | `Diagnostic[]` | Array de avisos e erros |\n| `stats` | `{ parseMs, transformMs, emitMs }` | Detalhamento de tempo em milissegundos |\n| `toc` | `TocEntry[]` | Entradas extraídas da table of contents |\n\n### Diagnostic\n\n| Propriedade | Tipo | Descrição |\n|----------|------|-------------|\n| `level` | `\"error\" \\| \"warn\"` | Nível de severidade |\n| `message` | `string` | Mensagem legível por humanos |\n| `start` | `number \\| undefined` | Offset de byte inicial na fonte |\n| `end` | `number \\| undefined` | Offset de byte final na fonte |\n| `line` | `number \\| undefined` | Número da linha (começando em 1) |\n| `column` | `number \\| undefined` | Número da coluna (começando em 1) |\n\n### TocEntry\n\nUm único heading extraído para a table of contents.\n\n| Propriedade | Tipo | Descrição |\n|----------|------|-------------|\n| `depth` | `number` | Nível do heading (1-6) |\n| `text` | `string` | Conteúdo de texto puro do heading |\n| `slug` | `string` | Slug gerado para vinculação por âncora |\n\n### SanitizeSchema\n\nRegras de sanitização customizadas.\n\n| Propriedade | Tipo | Descrição |\n|----------|------|-------------|\n| `allowedTags` | `string[]` | Tags HTML permitidas |\n| `allowedAttributes` | `Record<string, string[]>` | Atributos permitidos por tag |\n| `allowedProtocols` | `Record<string, string[]>` | Protocolos de URL permitidos por atributo |\n\n### UnifastPlugin\n\nA interface de plugin para estender o unifast.\n\n| Propriedade | Tipo | Descrição |\n|----------|------|-------------|\n| `name` | `string` | Nome único do plugin |\n| `options?` | `Partial<CompileOptions>` | Opções a mesclar nas opções de compilação |\n| `hastTransform?` | `(hast: HastRoot) => HastRoot` | Transforma a árvore HAST após a compilação |\n\n### Tipos de Nós HAST\n\n| Tipo | Campo `type` | Propriedades | Descrição |\n|------|-------------|------------|-------------|\n| `HastRoot` | `\"root\"` | `children: HastNode[]` | Nó raiz da árvore |\n| `HastElement` | `\"element\"` | `tagName`, `properties`, `children` | Um elemento HTML |\n| `HastText` | `\"text\"` | `value: string` | Um nó de texto |\n| `HastRaw` | `\"raw\"` | `value: string` | Passthrough de HTML bruto |\n| `HastComment` | `\"comment\"` | `value: string` | Um comentário HTML |\n| `HastDoctype` | `\"doctype\"` | - | Um nó `<!DOCTYPE html>` |\n\n`HastNode` é o tipo união: `HastRoot | HastElement | HastText | HastRaw | HastComment | HastDoctype`\n\n## Classes de Erro\n\n| Classe | Estende | Propriedades | Descrição |\n|-------|---------|------------|-------------|\n| `UnifastError` | `Error` | `code?: string`, `span?: { start, end }` | Classe base de erro para todos os erros do unifast |\n| `ParseError` | `UnifastError` | `code: \"PARSE_ERROR\"` | Lançado quando a entrada Markdown/MDX não pode ser parseada |\n| `CompileError` | `UnifastError` | `code: \"COMPILE_ERROR\"` | Lançado quando a compilação falha após o 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## Resumo de Exports\n\n| Export | Tipo | Descrição |\n|--------|------|-------------|\n| `CompileOptions` | type | Configuração de compilação |\n| `CompileResult` | type | Resultado da compilação |\n| `TocEntry` | type | Entrada da table of contents |\n| `SanitizeSchema` | type | Regras de sanitização |\n| `UnifastPlugin` | type | Interface de plugin |\n| `HastNode` | type | União de todos os tipos de nós HAST |\n| `HastRoot` | type | Nó raiz HAST |\n| `HastElement` | type | Nó de elemento HAST |\n| `HastText` | type | Nó de texto HAST |\n| `HastRaw` | type | Nó de HTML bruto HAST |\n| `HastComment` | type | Nó de comentário HAST |\n| `HastDoctype` | type | Nó de doctype HAST |\n| `hastToHtml` | function | Serializador de HAST para HTML |\n| `escapeHtml` | function | Escapa caracteres especiais HTML (`&`, `<`, `>`, `\"`) |\n| `extractLang` | function | Extrai identificador de linguagem de um elemento HAST `<code>` |\n| `extractText` | function | Extrai conteúdo de texto puro de um nó HAST |\n| `findCodeChild` | function | Encontra o elemento filho `<code>` dentro de um elemento `<pre>` |\n| `visitHast` | function | Utilitário de padrão visitor para percorrer árvores HAST |\n| `UnifastError` | class | Classe base de erro |\n| `ParseError` | class | Classe de erro de parse |\n| `CompileError` | class | Classe de erro de compilação |",
  "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"
    }
  ]
}