Boundary
Reference

API Reference

Detailed breakdown of classes, methods, and type definitions.

Boundary Class

static create(config: BoundaryConfig, adapters?: Map): Promise<Boundary>

Creates and initializes a new Boundary instance with the provided configuration.

getCircuitStatus(provider: string): CircuitBreakerStatus | null

Returns the current status of the circuit breaker for a specific provider.

Provider Client

Each configured provider exposes a client with the following HTTP methods:

get<T>(endpoint: string, options?: RequestOptions): Promise<NormalizedResponse<T>>
post<T>(endpoint: string, options?: RequestOptions): Promise<NormalizedResponse<T>>
put<T>(endpoint: string, options?: RequestOptions): Promise<NormalizedResponse<T>>
delete<T>(endpoint: string, options?: RequestOptions): Promise<NormalizedResponse<T>>
paginate<T>(endpoint: string, options?: RequestOptions): AsyncGenerator<NormalizedResponse<T>>