Setu-TS
    Preparing search index...

    Class OptionalDependencyUnavailableError

    Thrown when an optional, lazily-loaded dependency could not be imported.

    The original rejection is kept as cause for the log; packages that wrap the load in a named error of their own (the gRPC, SAML, GraphQL and feature-flags loaders) pass this class through as the cause of theirs.

    import { OptionalDependencyUnavailableError } from '@setu-ts/common';

    try {
      const mod = await import('ioredis');
    } catch (error) {
      throw new OptionalDependencyUnavailableError('ioredis', {
        cause: error, requiredBy: '@setu-ts/cache-plugin',
      });
    }

    0.10.0

    Hierarchy

    • Error
      • OptionalDependencyUnavailableError
    Index
    constructor
    cause? dependency message name stack? stackTraceLimit
    captureStackTrace prepareStackTrace

    • Builds the error. The message names the dependency and states both remedies: install it where the loading package is installed, in the version range that package declares for it, or choose an option that does not need it on this runtime.

      Parameters

      • dependency: string

        The bare package name the load failed for

      • Optionaloptions: { cause?: unknown; requiredBy?: string }

        The original rejection as cause and the loading package's npm name as requiredBy (added in 0.11.0); omitted names use generic wording

      Returns OptionalDependencyUnavailableError

    cause?: unknown
    dependency: string

    The bare package name the guarded import() could not load.

    message: string
    name: "OptionalDependencyUnavailableError" = 'OptionalDependencyUnavailableError'

    Discriminant for consumers that cannot use instanceof across realms.

    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