For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/api/genui/openui/core/classes/ToolNotFoundError.md.
Lynx
  • English
  • Class: ToolNotFoundError

    Standard error thrown when a tool name is not found in a function-map ToolProvider. Used by Renderer's inline normalization to give clear error messages.

    Extends

    • Error

    Constructors

    Constructor

    new ToolNotFoundError(toolName: string, availableTools?: string[]): ToolNotFoundError

    Parameters

    ParameterType
    toolNamestring
    availableTools?string[]

    Returns

    ToolNotFoundError

    Overrides

    Error.constructor

    Properties

    availableTools

    readonly availableTools: string[]


    cause?

    optional cause?: unknown

    Inherited from

    Error.cause


    message

    message: string

    Inherited from

    Error.message


    name

    name: string

    Inherited from

    Error.name


    stack?

    optional stack?: string

    Inherited from

    Error.stack


    toolName

    readonly toolName: string


    stackTraceLimit

    static 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.

    Inherited from

    Error.stackTraceLimit

    Methods

    captureStackTrace()

    static captureStackTrace(targetObject: object, constructorOpt?: Function): void

    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

    ParameterType
    targetObjectobject
    constructorOpt?Function

    Returns

    void

    Inherited from

    Error.captureStackTrace


    isError()

    static isError(error: unknown): error is Error

    Indicates whether the argument provided is a built-in Error instance or not.

    Parameters

    ParameterType
    errorunknown

    Returns

    error is Error

    Inherited from

    Error.isError


    prepareStackTrace()

    static prepareStackTrace(err: Error, stackTraces: CallSite[]): any

    Parameters

    ParameterType
    errError
    stackTracesCallSite[]

    Returns

    any

    See

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

    Inherited from

    Error.prepareStackTrace

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.