circuitBreaker .d.ts example doesn't provide a halfOpenAfter and would result in a TS error

[Tyriar]

From .d.ts:

     * // Break if more than 20% of requests fail in a 30 second time window:
     * const breaker = Policy
     *  .handleAll()
     *  .circuitBreaker(new SamplingBreaker(0.2, 30 * 1000));
     *
     * export function handleRequest() {
     *   return breaker.execute(() => getInfoFromDatabase());
     * }
     * ```
     *
     * @param breaker -- The circuit breaker to use. This package exports
     * ConsecutiveBreaker and SamplingBreakers for you to use.
     * @param halfOpenAfter -- Time after failures to try to open the circuit
     * breaker again. Defaults to 10 seconds.
     */
    circuitBreaker(halfOpenAfter: number, breaker: IBreaker): CircuitBreakerPolicy;

[Tyriar]

"Defaults to 10 seconds." is still there, does that mean is 0 is passed in for halfOpenAfter?

[connor4312]

There is no default, halfOpenAfter must be manually specified. Fixed that in the docs. I realized as a library I didn't know enough about the underlying service to determine an appropriate interval.

Updated docs:

cockatiel/src/Policy.ts

Lines 392 to 423 in d7b1d4f

	/**
	* Returns a circuit breaker for the policy. **Important**: you should share
	* your circuit breaker between executions of whatever function you're
	* wrapping for it to function!
	*
	* ```ts
	* import { SamplingBreaker, Policy } from 'cockatiel';
	*
	* // Break if more than 20% of requests fail in a 30 second time window:
	* const breaker = Policy
	* .handleAll()
	* .circuitBreaker(10_000, new SamplingBreaker(0.2, 30 * 1000));
	*
	* export function handleRequest() {
	* return breaker.execute(() => getInfoFromDatabase());
	* }
	* ```
	*
	* @param halfOpenAfter Time after failures to try to open the circuit
	* breaker again.
	* @param breaker The circuit breaker to use. This package exports
	* ConsecutiveBreaker and SamplingBreakers for you to use.
	*/
	public circuitBreaker(halfOpenAfter: number, breaker: IBreaker) {
	return new CircuitBreakerPolicy(
	{
	breaker,
	halfOpenAfter,
	},
	new ExecuteWrapper(this.options.errorFilter, this.options.resultFilter),
	);
	}