Setu-TS
    Preparing search index...

    Class ReadOnlySecretProviderError

    Thrown when a secret is written through a provider that cannot store.

    EnvProvider is the read-only provider: environment variables are process state, immutable at runtime. set is the provider's ONLY write method and rejects with this class, so both public write operations inherit the refusal from one site — SecretsService.rotate() delegates to provider.set(). It rejects, never throws synchronously: a synchronous throw from a method typed Promise<void> would bypass any caller using .catch(), the M52b/M52c/M70j defect class.

    The status is 501, not 403: nothing is wrong with the caller or its credentials — the deployment's provider cannot perform the operation at all, which is what 501 means.

    import { ReadOnlySecretProviderError } from '@setu-ts/secrets-plugin';
    try {
      await secrets.set('database/password', 'next');
    } catch (err) {
      if (err instanceof ReadOnlySecretProviderError) {
        // The configured provider is read-only; use a writable provider.
      }
    }

    0.5.0

    Hierarchy

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

    Discriminant for consumers that cannot use instanceof across realms.

    provider: string

    The provider that refused the write (e.g. 'EnvProvider').

    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