Proton Drive CLI API Documentation - v0.1.2
    Preparing search index...

    Class CircuitBreaker

    Circuit breaker for protecting against cascading failures

    Automatically opens after repeated failures, preventing further requests until a recovery timeout elapses. Then enters half-open state to test recovery.

    Index

    Constructors

    constructor

    Properties

    failureCount halfOpenAttempts lastFailureTime name options state successCount

    Methods

    execute getFailureCount getState getStats isOpen onFailure onSuccess reset

    Constructors

    Properties

    failureCount: number = 0
    halfOpenAttempts: number = 0
    lastFailureTime: number = 0
    name: string
    options: CircuitBreakerOptions = ...
    state: CircuitState = CircuitState.CLOSED
    successCount: number = 0

    Methods

    • Execute an operation through the circuit breaker

      Type Parameters

      • T

      Parameters

      • operation: () => Promise<T>

        Async operation to execute

      Returns Promise<T>

      Result of the operation

      CircuitBreakerError if circuit is open

    • Get circuit breaker statistics

      Returns {
          failureCount: number;
          lastFailureTime: number;
          state: CircuitState;
          successCount: number;
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods