Agent Maturity Compass API - v1.2.0
    Preparing search index...

    Class LlmStreamProtocolError

    Thrown when an adapter breaks the stream contract.

    Deliberately NOT an LlmError. An LlmError carries provider facts that a retry policy reads; this carries the news that our own adapter is wrong. Keeping them separate classes means a caller distinguishes them with instanceof rather than by inspecting a code prefix, and no policy can ever decide to retry a protocol bug.

    Hierarchy

    • Error
      • LlmStreamProtocolError
    Index
    • Parameters

      • code: LlmStreamProtocolCode
      • message: string
      • context: {
            blockIndex?: number;
            chunkType?:
                | "block-start"
                | "text-delta"
                | "thinking-delta"
                | "tool-call-delta"
                | "block-end"
                | "usage"
                | "finish";
        } = {}

      Returns LlmStreamProtocolError

    blockIndex: number | null

    The block index involved, when the rule is about a block.

    cause?: unknown
    chunkType:
        | "block-start"
        | "text-delta"
        | "thinking-delta"
        | "tool-call-delta"
        | "block-end"
        | "usage"
        | "finish"
        | null

    The chunk that violated the rule; null when the violation is the absence of one.

    message: string
    name: string
    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