Interface HomeportConfig

interface HomeportConfig {
    apiKey?: string;
    baseUrl: string;
    cache?: HomeportCacheConfig;
    circuitBreaker?: false | HomeportCircuitBreakerConfig;
    hooks?: HomeportHooks;
    retryConfig?: HomeportRetryConfig;
    traceContext?: { traceparent?: string; tracestate?: string };
    verbose?: boolean;
}

Index

Properties

apiKey? baseUrl cache? circuitBreaker? hooks? retryConfig? traceContext? verbose?

Properties

`Optional`apiKey

apiKey?: string

Bearer API key for authenticated endpoints

baseUrl

baseUrl: string

Homeport base URL (e.g. 'https://homeport.example.com')

`Optional`cache

cache?: HomeportCacheConfig

Opt-in response caching for GET requests.

`Optional`circuitBreaker

circuitBreaker?: false | HomeportCircuitBreakerConfig

Circuit breaker configuration. Pass false to disable.

`Optional`hooks

hooks?: HomeportHooks

Request/response lifecycle hooks

`Optional`retryConfig

retryConfig?: HomeportRetryConfig

Override default retry configuration

`Optional`traceContext

traceContext?: { traceparent?: string; tracestate?: string }

OpenTelemetry trace context to propagate.

`Optional`verbose

verbose?: boolean

Enable debug logging