UNPKG

fluentrest-ts

Version:

A lightweight, fluent TypeScript API testing library inspired by Java's RestAssured. Built on top of Axios, JSONPath, and Joi for powerful request handling and response validation.

40 lines (39 loc) 1.42 kB
import { AxiosProxyConfig } from "axios"; import { LogLevel } from "./logger"; export type ProxyConfig = AxiosProxyConfig | string; /** * Default configuration values for the RestAssured client. * Can be overridden globally via environment or locally at runtime. */ export type RestAssuredDefaults = { timeout: number; logLevel: LogLevel; logFilePath: string; baseUrl: string; proxy?: ProxyConfig; }; /** * Globally override the default configuration. * Call this once at the beginning of your test suite if needed. * * Example: * configureDefaults({ logLevel: "none", timeout: 30000 }); * * @param overrides Partial configuration to apply on top of current defaults */ export declare function configureDefaults(overrides: Partial<RestAssuredDefaults>): void; /** * Get the current global default configuration. * Useful for reading the active settings in internal modules (e.g. logger). * * Note: Does not merge or clone — returns internal state. */ export declare function getCurrentDefaults(): RestAssuredDefaults; /** * Merge instance-level overrides with global defaults. * Used internally by `fluentRest(...)` and `RestAssuredCore` to create per-request config. * * @param overrides Optional per-instance overrides * @returns A new merged configuration object */ export declare function getMergedDefaults(overrides?: Partial<RestAssuredDefaults>): RestAssuredDefaults;