Powered by Mintlify
Auto-generate your docs
Isomorphic HTTP client with retries, circuit breaker, and localized errors
Documentation Index
Fetch the complete documentation index at: https://mintlify.com/sebamar88/bytekit/llms.txt
Use this file to discover all available pages before exploring further.
ApiClient class is a powerful, isomorphic HTTP client that works in both Node.js and browsers. It provides automatic retries, circuit breaker patterns, localized error messages, request/response interceptors, and comprehensive logging.
import { ApiClient } from "bytekit";
// or
import { ApiClient } from "bytekit/api-client";
Show properties
get<T>(endpoint: string, options?: RequestOptions): Promise<T>
post<T>(endpoint: string, body?: unknown, options?: RequestOptions): Promise<T>
put<T>(endpoint: string, body?: unknown, options?: RequestOptions): Promise<T>
patch<T>(endpoint: string, body?: unknown, options?: RequestOptions): Promise<T>
delete<T>(endpoint: string, options?: RequestOptions): Promise<T>
list<T, TFilter>(endpoint: string, options?: ListOptions<TFilter>): Promise<PaginatedResponse<T>>
import { ApiClient } from "bytekit";
const api = new ApiClient({
baseUrl: "https://api.example.com",
defaultHeaders: {
"X-API-Key": process.env.API_KEY
},
locale: "en",
retryPolicy: {
maxAttempts: 3,
initialDelayMs: 100
},
circuitBreaker: {
failureThreshold: 5,
resetTimeoutMs: 60000
}
});
// GET request
const users = await api.get<User[]>("/users");
// POST request
const newUser = await api.post<User>("/users", {
name: "John Doe",
email: "john@example.com"
});
// Paginated list with filters
const result = await api.list<User, { status: string }>("/users", {
pagination: { page: 1, limit: 20 },
sort: { field: "createdAt", order: "desc" },
filters: { status: "active" }
});
import { ApiError } from "bytekit";
try {
const data = await api.get("/users");
} catch (error) {
if (error instanceof ApiError) {
console.error(`HTTP ${error.status}: ${error.message}`);
console.error(error.body);
}
}