planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-people-ts/src / CircuitBreaker

Class: CircuitBreaker

Defined in: packages/planning-center-people-ts/src/error-scenarios.ts:104 

Circuit breaker for API calls

Constructors

Constructor

new CircuitBreaker(failureThreshold, recoveryTimeout, monitoringPeriod): CircuitBreaker

Defined in: packages/planning-center-people-ts/src/error-scenarios.ts:109 

Parameters

failureThreshold

number = 5

recoveryTimeout

number = 60000

monitoringPeriod

number = 60000

Returns

CircuitBreaker

Methods

execute()

execute<T>(operation): Promise<T>

Defined in: packages/planning-center-people-ts/src/error-scenarios.ts:115 

Type Parameters

T

T

Parameters

operation

() => Promise<T>

Returns

Promise<T>

getState()

getState(): string

Defined in: packages/planning-center-people-ts/src/error-scenarios.ts:150 

Returns

string

getFailureCount()

getFailureCount(): number

Defined in: packages/planning-center-people-ts/src/error-scenarios.ts:154 

Returns

number