Interface RuntimeDiagnostics

Reads and resets the middleware every view shares. Each answers for the whole runtime, not for one view.

interface RuntimeDiagnostics {
    getCacheStats(): CacheStats | null;
    clearCache(): void;
    updateCacheConfig(config: Partial<ETagCacheConfig>): void;
    getCircuitBreakerStats(): CircuitBreakerStats | null;
    resetCircuitBreaker(endpoint?: string): void;
    getDeduplicatorStats(): { pendingRequests: number } | null;
}

Index

Methods

getCacheStats clearCache updateCacheConfig getCircuitBreakerStats resetCircuitBreaker getDeduplicatorStats

Methods

getCacheStats

getCacheStats(): CacheStats | null
The cache's entries, hits and misses; null when the ETag cache is off.

Returns CacheStats | null
- Defined in src/client/runtime.ts:154

clearCache

clearCache(): void
Drops every view's cached entries.

Returns void
- Defined in src/client/runtime.ts:156

updateCacheConfig

updateCacheConfig(config: Partial<ETagCacheConfig>): void
Changes the built-in cache's limits in place; a supplied cache keeps its own.
Parameters
- config: Partial<ETagCacheConfig>
Returns void
- Defined in src/client/runtime.ts:158

getCircuitBreakerStats

getCircuitBreakerStats(): CircuitBreakerStats | null
Each endpoint's circuit and failure count; null when the circuit breaker is off.

Returns CircuitBreakerStats | null
- Defined in src/client/runtime.ts:160

resetCircuitBreaker

resetCircuitBreaker(endpoint?: string): void
Closes one endpoint's circuit, or every circuit when endpoint is left out.
Parameters
- Optionalendpoint: string
Returns void
- Defined in src/client/runtime.ts:162

getDeduplicatorStats

getDeduplicatorStats(): { pendingRequests: number } | null
How many requests are in flight for others to join; null when deduplication is off.

Returns { pendingRequests: number } | null
- Defined in src/client/runtime.ts:164