Skip to content

Commit d4786fa

Browse files
refactor: CHANGELOG
1 parent e1bc518 commit d4786fa

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,24 @@ All notable changes to this project are documented in this file.
44

55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [0.4.0] - 2026-04-11
7+
## About OpenFetch
8+
9+
**OpenFetch** (`@hamdymohamedak/openfetch`) is a small, **dependency-free** HTTP client for any JavaScript runtime that provides the standard [`fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API (Node 18+, Bun, Deno, Cloudflare Workers, browsers). It focuses on a single transport layer, **no legacy browser-only globals** (`window`, `document`, `localStorage`), so it stays **SSR- and React Server Component–friendly**.
10+
11+
**Core surface:** default export and `createClient()` / `create()` instances with `baseURL`, query `params`, `headers`, `timeout`, `signal`, body helpers, `responseType`, `validateStatus`, request/response **interceptors**, and async **middleware** wrapping the fetch adapter.
12+
13+
**Built-in capabilities:** `OpenFetchError` with structured shapes, **`createRetryMiddleware()`** (backoff, total/per-attempt timeouts, idempotency key helpers for retried POSTs), **`MemoryCacheStore`** and **`createCacheMiddleware()`** (TTL, optional stale-while-revalidate).
14+
15+
**Optional entry points (tree-shaking):**
16+
17+
- `@hamdymohamedak/openfetch/plugins``retry()`, `timeout()`, `hooks()`, `debug()` (e.g. masked headers in logs), `strictFetch()`.
18+
- `@hamdymohamedak/openfetch/sugar`**`createFluentClient()`**: URL + method chaining (`.get()`, `.post()`, …), terminals like `.json()`, `.text()`, `.send()`, **`.raw()`** (native `Response` without adapter body parsing on that path), and **`.memo()`** (one HTTP round-trip; body buffered once for multiple terminals—not HTTP cache).
19+
20+
For a feature matrix, examples, and execution order (middleware vs retry vs interceptors), see the [README](https://github.com/openfetch-js/OpenFetch/blob/main/README.md).
21+
22+
---
23+
24+
## [0.2.8] - 2026-04-14
825

926
### Added
1027

0 commit comments

Comments
 (0)