@hyperttp/parser

Официальный плагин автоматического парсинга и конвертации ответов для HTTP-клиента Hyperttp. Работает на фазе FORMAT, вычитывает входящий поток данных (body stream) и преобразует его в JavaScript-объекты, XML, строки или полноценные DOM-деревья Cheerio на основе заголовков Content-Type или параметра responseType.

Особенности

• 🤖 Автоматическое определение (auto): Самостоятельно распознает форматы JSON, XML и Text, избавляя от необходимости вызывать .json() вручную.
• 🦅 Интеграция с Cheerio: При получении HTML-страниц автоматически оборачивает тело ответа в инстанс cheerio, позволяя сразу выполнять jQuery-подобные запросы для парсинга и скрейпинга.
• ⏱️ Метрики производительности: Точно замеряет время, затраченное на десериализацию данных, и сохраняет результат в req.meta.timings.parsingMs (при включенном trackTimings).
• 🧹 Безопасная очистка (Stream Cleanup): В случае ответов с ошибками (HTTP Status >= 400) или сбоев вычитки плагин корректно закрывает/вызывает cancel() / destroy() у нативных стримов, предотвращая утечки памяти.

Установка

# С использованием bun
bun add @hyperttp/parser

# С использованием npm/pnpm
npm install @hyperttp/parser

Использование

Плагин автоматически активируется на фазе FORMAT для всех типов запросов, кроме HEAD, buffer и stream.

Базовый пример

import { HyperClient } from "@hyperttp/core";
import "@hyperttp/parser"; // Подключение расширения типов HttpClientOptions

const client = new HyperClient({
  responseConverter: {
    // Опции конфигурации парсера (передаются в экземпляр ResponseConverter)
    charset: "utf-8"
  }
});

// 1. Автоматический парсинг JSON
const jsonResult = await client.get<{ id: number }>("https://api.example.com/user/1");
console.log(jsonResult.id);

// 2. Автоматический парсинг HTML в Cheerio
const $ = await client.get<any>("https://example.com/page", {
  meta: { responseType: "html" } 
});
const pageTitle = $("head title").text();

Мониторинг времени парсинга

Если активирован трекинг таймингов, плагин обогатит объект meta:

const req = {
  url: "[https://api.example.com/heavy-data](https://api.example.com/heavy-data)",
  method: "GET",
  meta: { trackTimings: true }
};

const data = await client.execute(req);
console.log(Время парсинга: ${req.meta.timings?.parsingMs} ms);

Как это работает (Архитектура)

Плагин перехватывает управление в момент возврата ответа из сети на фазе FORMAT:

graph TD
    Net[Ответ из сети NETWORK] --> Hook[Фаза FORMAT]
    Hook --> CheckType{Тип ответа HEAD, buffer или stream?}
    
    CheckType -- Да --> Bypass[Пропустить без изменений] --> Return[Возврат пользователю]
    CheckType -- Нет --> CheckStatus{Status >= 400?}
    
    CheckStatus -- Да --> Clean[Очистка/Закрытие Стрима] --> Return
    CheckStatus -- Нет --> Read[Вычитка потока данных в буфер]
    
    Read --> Convert[Конвертация: JSON / XML / Cheerio / Text]
    Convert --> Track{trackTimings === true?}
    
    Track -- Да --> Calc[Вычисление parsingMs] --> Return
    Track -- Нет --> Return

Loading

Лицензия

MIT © dirold2