Getting Started

Installation

npm install zlient zod
# or
bun add zlient zod

WARNING

zod is a peer dependency. You must install it alongside zlient.

Quick Start

1. Initialize Client

import { HttpClient } from 'zlient';

const client = new HttpClient({
  baseUrls: { 
    default: 'https://api.example.com' 
  }
});

2. Define an Endpoint

import { z } from 'zod';

const getUser = client.createEndpoint({
  method: 'GET',
  path: (p) => `/users/${p.id}`,
  pathParams: z.object({ id: z.string() }),
  response: z.object({
    id: z.string(),
    name: z.string()
  })
});

3. Call it

const user = await getUser({
  pathParams: { id: '123' }
});