Setu-TS
    Preparing search index...

    Class SecretProviderUnavailableError

    Thrown when a secrets provider cannot be reached: the request failed on the network, or it did not answer within the provider's bound (M101a V8-4).

    Branded with a 503 Service Unavailable status hint, so errorHandler answers a retryable status with a fixed, caller-safe sentence instead of masking an outage into a 500. The transport error rides as cause for the log and never reaches the response body (the M89b rule). An HTTP error status from a provider that DID answer is not this error: the provider was reachable.

    import { SecretProviderUnavailableError } from '@setu-ts/secrets-plugin';
    try {
      await secrets.get('database/password');
    } catch (err) {
      if (err instanceof SecretProviderUnavailableError) {
        // Vault did not answer — retry later, or fail the request with 503.
      }
    }

    0.9.0

    Hierarchy

    • Error
      • SecretProviderUnavailableError
    Index
    constructor
    cause? message name provider stack? stackTraceLimit
    captureStackTrace prepareStackTrace
    cause?: unknown
    message: string
    name: "SecretProviderUnavailableError" = 'SecretProviderUnavailableError'

    Discriminant for consumers that cannot use instanceof across realms.

    provider: string

    The provider that could not be reached (e.g. 'HashiCorpVaultProvider').

    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

      https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods