Skip to Content
✨ New: Auth Plugin. JWT, OAuth2, API Key, and more authentication strategies out of the box. Read more... 🎉
Getting Started

Getting Started

endpoint-fetcher is a lightweight, type-safe API client builder for TypeScript built on the Fetch API.

Installation

npm install endpoint-fetcher

Quick Start

import { createApiClient, get, post, del } from 'endpoint-fetcher';
 
type User = { id: string; name: string; email: string };
type CreateUserInput = { name: string; email: string };
 
const api = createApiClient({
  listUsers:  get<void, User[]>('/users'),
  getUser:    get<{ id: string }, User>((input) => `/users/${input.id}`),
  createUser: post<CreateUserInput, User>('/users'),
  deleteUser: del<{ id: string }, void>((input) => `/users/${input.id}`),
}, {
  baseUrl: 'https://api.example.com',
});
 
const users = await api.listUsers();
const user  = await api.getUser({ id: '123' });
const newUser = await api.createUser({ name: 'Jane', email: 'jane@example.com' });

Every call is fully typed — TypeScript infers inputs, outputs, and errors.

What endpoint-fetcher provides

  • Type safety — Full TypeScript inference for inputs, outputs, and error shapes
  • HTTP helpers — get, post, put, patch, del for defining endpoints
  • Groups — Organize endpoints hierarchically with shared hooks and base paths
  • Hooks — Intercept requests/responses globally, per group, or per endpoint
  • Plugins — Extend with caching, retries, and custom logic via official plugins
  • Custom handlers — Override the default JSON behavior for files, streaming, etc.

Next Steps

  • Basic Usage — Define endpoints, call them, handle responses
  • Groups — Organize large APIs with nested groups and base paths
  • Hooks — Add auth, logging, and error handling
  • Plugins — Official cache and retry plugins
Basic Usage