Home - sebamar88/bytekit GitHub Wiki

🧰 bytekit Wiki

The zero-dependency TypeScript toolkit for isomorphic HTTP networking, async orchestration, and developer productivity.

🇪🇸 El toolkit TypeScript sin dependencias para networking HTTP isomórfico, orquestación asíncrona y productividad del desarrollador.

📚 Table of Contents / Tabla de Contenidos

🌐 Core — Networking & HTTP

Module	Description (EN)	Descripción (ES)
ApiClient	Full-featured HTTP client with interceptors, retry, cache & streaming	Cliente HTTP completo con interceptores, reintentos, caché y streaming
RetryPolicy	Retry strategies with exponential/linear/custom backoff	Estrategias de reintento con backoff exponencial/lineal/personalizado
CircuitBreaker	Circuit breaker pattern (closed → open → half-open)	Patrón circuit breaker (cerrado → abierto → semi-abierto)
ResponseValidator	Validate API responses against schemas	Valida respuestas de API contra esquemas
SchemaAdapter	Transform API payloads between different schemas	Transforma payloads de API entre diferentes esquemas

⚡ Async — Asynchronous Utilities

Module	Description (EN)	Descripción (ES)
Async Toolkit	sleep, timeout, retry, parallel, sequential, race, allSettled, debounce, throttle	sleep, timeout, retry, parallel, sequential, race, allSettled, debounce, throttle

📦 Caching & Deduplication

Module	Description (EN)	Descripción (ES)
CacheManager	TTL-based in-memory cache with LRU eviction	Caché en memoria con TTL y desalojo LRU
RequestCache	HTTP request-level caching	Caché a nivel de petición HTTP
RequestDeduplicator	Deduplicates identical in-flight requests	Deduplica peticiones idénticas en vuelo

🔒 Security & Cryptography

Module	Description (EN)	Descripción (ES)
CryptoUtils	Tokens, UUIDs, hashing, HMAC, AES-256-GCM encryption	Tokens, UUIDs, hashing, HMAC, cifrado AES-256-GCM

🛡️ Error Handling & Resilience

Module	Description (EN)	Descripción (ES)
ErrorBoundary	Application error boundary with typed errors & recovery	Boundary de errores con tipos y recuperación
RateLimiter	Token bucket / sliding window rate limiting	Limitador de tasa con token bucket / ventana deslizante

📊 Observability & Debugging

Module	Description (EN)	Descripción (ES)
Logger	Structured logging with levels, formatters & transports	Logging estructurado con niveles, formateadores y transportes
Profiler	Performance profiling & debug timing utilities	Perfilado de rendimiento y utilidades de temporización

🔧 Helpers & Utilities

Module	Description (EN)	Descripción (ES)
EventEmitter	Typed pub/sub event system	Sistema de eventos pub/sub tipado
PollingHelper	Configurable polling with backoff & abort	Polling configurable con backoff y cancelación
FileUploadHelper	File uploads with chunking & progress	Subida de archivos con chunking y progreso
StreamingHelper	Stream reading, SSE parsing, NDJSON	Lectura de streams, parsing SSE, NDJSON
WebSocketHelper	WebSocket client with auto-reconnect	Cliente WebSocket con reconexión automática
UrlHelper	URL parsing, building, query params & slugify	Parsing de URL, construcción, query params y slugify
DiffUtils	Deep/shallow object diffing, patch/unpatch	Diff profundo/superficial de objetos, patch/unpatch
CompressionUtils	LZ-based string compression	Compresión de strings basada en LZ

💾 Storage & Environment

Module	Description (EN)	Descripción (ES)
StorageManager	Isomorphic localStorage/sessionStorage abstraction	Abstracción isomórfica de localStorage/sessionStorage
EnvManager	Environment variable management with validation	Gestión de variables de entorno con validación

🖥️ CLI Tools

Module	Description (EN)	Descripción (ES)
CLI Overview	bytekit command-line interface	Interfaz de línea de comandos de bytekit
Type Generator	Generate TypeScript types from API responses	Genera tipos TypeScript a partir de respuestas de API
Swagger Generator	Generate DTOs from OpenAPI/Swagger specs	Genera DTOs a partir de specs OpenAPI/Swagger
DDD Scaffolding	Hexagonal architecture boilerplate generator	Generador de boilerplate con arquitectura hexagonal

🗺️ Architecture Overview / Vista General de la Arquitectura

bytekit
├── Core HTTP         ApiClient ← RetryPolicy ← CircuitBreaker
│                       ↕              ↕
│                   RequestCache   ResponseValidator ← SchemaAdapter
│                   RequestDeduplicator
│
├── Async             sleep · timeout · retry · parallel · sequential
│                     race · allSettled · debounce · throttle
│
├── Caching           CacheManager (LRU + TTL)
│
├── Security          CryptoUtils (tokens, hashing, encryption)
│
├── Resilience        ErrorBoundary · RateLimiter
│
├── Observability     Logger · Profiler
│
├── Helpers           EventEmitter · PollingHelper · FileUploadHelper
│                     StreamingHelper · WebSocketHelper · UrlHelper
│                     DiffUtils · CompressionUtils
│
├── Storage           StorageManager · EnvManager
│
└── CLI               --type · --swagger · --ddd

🚀 Quick Start / Inicio Rápido

# Install / Instalar
npm install bytekit
# or / o
pnpm add bytekit

// HTTP Client
import { ApiClient } from "bytekit/api-client";

// Async Utilities
import { sleep, retry, parallel } from "bytekit/async";

// Caching
import { CacheManager } from "bytekit/cache";

// CLI (from terminal)
// npx bytekit --type https://api.example.com/users

🔗 Quick Links / Enlaces Rápidos

Resource	Link
📦 npm	bytekit on npm
🐙 GitHub	bytekit on GitHub
📂 Examples	examples/
📖 API Docs	API Reference
📝 Changelog	CHANGELOG.md
🤝 Contributing	CONTRIBUTING.md

📖 All Wiki Pages / Todas las Páginas del Wiki

Last updated: 2025