@probitas/client-http

HTTP client for Probitas scenario testing framework.

This package provides an HTTP client designed for integration testing of HTTP APIs.

Features

• All HTTP Methods: Support for GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
• Request Building: Headers, query parameters, body (JSON, form, multipart)
• Response Inspection: Status codes, headers, cookies, body parsing
• Duration Tracking: Built-in timing for performance monitoring
• Resource Management: Implements AsyncDisposable for proper cleanup

Installation

deno add jsr:@probitas/client-http

Quick Start

import { createHttpClient } from "@probitas/client-http";

const http = createHttpClient({ url: "http://localhost:3000" });

// GET request
const res = await http.get("/users/123");
console.log("Status:", res.status);

// Extract typed data
const user = res.json<User>();

// POST request
const created = await http.post("/users", {
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ name: "Jane" }),
});
console.log("Created:", created.status);

await http.close();

Using with using Statement

await using http = createHttpClient({ url: "http://localhost:3000" });

const res = await http.get("/health");
console.log("Health:", res.ok);
// Client automatically closed when block exits

Related Packages

Package	Description
@probitas/client	Core utilities and types
@probitas/client-graphql	GraphQL client

Links

• GitHub Repository
• Probitas Framework

deno add jsr:@probitas/client-http

class HttpBadRequestError extends HttpError

new HttpBadRequestError(message: string, options?: HttpErrorOptions)

class HttpConflictError extends HttpError

new HttpConflictError(message: string, options?: HttpErrorOptions)

class HttpError extends ClientError

new HttpError(message: string, status: number, statusText: string, options?: HttpErrorOptions)

class HttpForbiddenError extends HttpError

new HttpForbiddenError(message: string, options?: HttpErrorOptions)

class HttpInternalServerError extends HttpError

new HttpInternalServerError(message: string, options?: HttpErrorOptions)

class HttpNotFoundError extends HttpError

new HttpNotFoundError(message: string, options?: HttpErrorOptions)

class HttpTooManyRequestsError extends HttpError

new HttpTooManyRequestsError(message: string, options?: HttpErrorOptions)

class HttpUnauthorizedError extends HttpError

new HttpUnauthorizedError(message: string, options?: HttpErrorOptions)

interface CookieConfig

interface HttpClient extends AsyncDisposable

get(path: string, options?: HttpOptions): Promise<HttpResponse>

post(path: string, body?: BodyInit, options?: HttpOptions): Promise<HttpResponse>

put(path: string, body?: BodyInit, options?: HttpOptions): Promise<HttpResponse>

patch(path: string, body?: BodyInit, options?: HttpOptions): Promise<HttpResponse>

delete(path: string, options?: HttpOptions): Promise<HttpResponse>

request(method: string, path: string, options?: HttpOptions & { body?: BodyInit }): Promise<HttpResponse>

getCookies(): Record<string, string>

setCookie(name: string, value: string): void

clearCookies(): void

close(): Promise<void>

interface HttpClientConfig extends CommonOptions

interface HttpConnectionConfig extends CommonConnectionConfig

interface HttpErrorOptions extends ErrorOptions

interface HttpOptions extends CommonOptions

interface HttpResponse

arrayBuffer(): ArrayBuffer | null

blob(): Blob | null

text(): string | null

data<T = any>(): T | null

function createHttpClient(config: HttpClientConfig): HttpClient

const http = createHttpClient({ url: "http://localhost:3000" });

const response = await http.get("/users/123");
console.log(response.data());

await http.close();

const http = createHttpClient({
  url: { host: "api.example.com", port: 443, protocol: "https" },
});

const http = createHttpClient({
  url: "http://localhost:3000",
  headers: {
    "Authorization": "Bearer token123",
    "Accept": "application/json",
  },
});

await using http = createHttpClient({ url: "http://localhost:3000" });
const response = await http.get("/health");
// Client automatically closed when scope exits

async function createHttpResponse(raw: globalThis.Response, duration: number): Promise<HttpResponse>

type BodyInit = string | Uint8Array | Record<string, unknown> | FormData | URLSearchParams

type QueryValue = string | number | boolean

type RedirectMode = "follow" | "manual" | "error"