Skip to content
TypeWire

@tahanabavi/typefetch

v2.0.0

A strongly typed TypeScript HTTP client powered by Zod contracts, middleware, retries, mock data, contract testing, CLI tooling, and report generation.

Versioned Release Documentation

Starting with v1.6.0, detailed documentation for larger updates is stored separately under docs/releases.

The main README stays focused on quick usage and core concepts, while release files contain deeper implementation notes, migration details, CLI examples, test strategy, and full feature explanations.

Recommended structure:

txt
docs/
  releases/
    v1.6.0.md
    v1.6.7.md
    v1.7.0.md
    v1.8.0.md
    v1.9.0.md
    v2.0.0.md

The v2.0.0 document carries the full migration table for pluggable transports and the package split — read it before upgrading.

Notes

  • Always call client.init() before using client.modules.

  • All request inputs are validated with Zod.

  • All successful responses are validated with Zod.

  • Structured request schemas are recommended for new APIs.

  • Flat request schemas are still supported for backward compatibility.

  • GET requests do not send a body.

  • form-data endpoints should use bodyType: "form-data".

  • Auth tokens are only required for endpoints with auth: true.

  • Mock data bypasses network calls but still validates responses.

  • Every generated method exposes endpointId and endpoint metadata.

  • Instrumentation is opt-in; with no hook registered, request handling is unchanged.

  • Runtime overrides change a single request without mutating the contract.

  • Use npx typewire test --mode schema for fast contract validation.

  • Keep detailed release documentation in docs/releases.