> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AvroError

> AvroError — Kinetica TypeScript API

<div className="kinetica-typedoc">
  <div className="tsd-page-title" />

  <div className="section tsd-panel tsd-comment">
    <div className="tsd-comment tsd-typography">
      <p>Thrown when a value does not fit its schema, when binary data cannot be decoded with the schema given, or when a schema itself is invalid.</p>
    </div>
  </div>

  <div className="section tsd-panel tsd-hierarchy" data-refl="5317">
    <h4>Hierarchy</h4>

    <ul className="tsd-hierarchy">
      <li className="tsd-hierarchy-item">
        <span className="tsd-signature-type">Error</span>

        <ul className="tsd-hierarchy">
          <li className="tsd-hierarchy-item"><span className="tsd-hierarchy-target">AvroError</span></li>
        </ul>
      </li>
    </ul>
  </div>

  <div className="aside tsd-sources">
    <ul>
      <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/avro.ts#L42">src/avro.ts:42</a></li>
    </ul>
  </div>

  <div className="section tsd-panel-group tsd-index-group">
    <div className="section tsd-panel tsd-index-panel">
      <div className="details tsd-index-content tsd-accordion" open="">
        <div className="summary tsd-accordion-summary tsd-index-summary">
          <h5 className="tsd-index-heading uppercase">Index</h5>
        </div>

        <div className="tsd-accordion-details">
          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="constructors">Constructors</h3>
            <div className="tsd-index-list"><a href="#constructor" className="tsd-index-link"><span>constructor</span></a> </div>
          </div>

          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="properties">Properties</h3>
            <div className="tsd-index-list"><a href="#message" className="tsd-index-link tsd-is-inherited tsd-is-external"><span>message</span></a> <a href="#name" className="tsd-index-link tsd-is-inherited tsd-is-external"><span>name</span></a> <a href="#path" className="tsd-index-link"><span>path</span></a> <a href="#stack" className="tsd-index-link tsd-is-inherited tsd-is-external"><span>stack?</span></a> <a href="#stacktracelimit" className="tsd-index-link tsd-is-inherited tsd-is-external"><span>stackTraceLimit</span></a> </div>
          </div>

          <div className="section tsd-index-section">
            <h3 className="tsd-index-heading tsd-anchor-link" id="methods">Methods</h3>
            <div className="tsd-index-list"><a href="#capturestacktrace" className="tsd-index-link tsd-is-inherited tsd-is-external"><span>captureStackTrace</span></a> <a href="#preparestacktrace" className="tsd-index-link tsd-is-inherited tsd-is-external"><span>prepareStackTrace</span></a> </div>
          </div>
        </div>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Constructors">
      <h2 className="tsd-anchor-link" id="constructors-1">Constructors</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="constructor"><span>constructor</span></h3>

        <ul className="tsd-signatures">
          <li className="">
            <div className="tsd-signature tsd-anchor-link" id="constructoravroerror"><span className="tsd-signature-keyword">new</span> <span className="tsd-kind-constructor-signature">AvroError</span><span className="tsd-signature-symbol">(</span><span className="tsd-kind-parameter">reason</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">)</span><span className="tsd-signature-symbol">:</span> <a href="" className="tsd-signature-type tsd-kind-class">AvroError</a></div>

            <div className="tsd-description">
              <div className="tsd-parameters">
                <h4 className="tsd-parameters-title">Parameters</h4>

                <ul className="tsd-parameter-list">
                  <li><span><span className="tsd-kind-parameter">reason</span>: <span className="tsd-signature-type">string</span></span></li>
                </ul>
              </div>

              <h4 className="tsd-returns-title">Returns <a href="" className="tsd-signature-type tsd-kind-class">AvroError</a></h4>

              <div className="aside tsd-sources">
                <p>Overrides Error.constructor</p>

                <ul>
                  <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/avro.ts#L48">src/avro.ts:48</a></li>
                </ul>
              </div>
            </div>
          </li>
        </ul>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Properties">
      <h2 className="tsd-anchor-link" id="properties-1">Properties</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member tsd-is-inherited tsd-is-external">
        <h3 className="tsd-anchor-link" id="message"><span>message</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">message</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="aside tsd-sources">
          <p>Inherited from Error.message</p>

          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/../kinetica-docs/mintlify/.typedoc/typedoc-0.28.20-ts-5.9.3/node_modules/typescript/lib/lib.es5.d.ts#L1077">../kinetica-docs/mintlify/.typedoc/typedoc-0.28.20-ts-5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1077</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member tsd-is-inherited tsd-is-external">
        <h3 className="tsd-anchor-link" id="name"><span>name</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">name</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span></div>

        <div className="aside tsd-sources">
          <p>Inherited from Error.name</p>

          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/../kinetica-docs/mintlify/.typedoc/typedoc-0.28.20-ts-5.9.3/node_modules/typescript/lib/lib.es5.d.ts#L1076">../kinetica-docs/mintlify/.typedoc/typedoc-0.28.20-ts-5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1076</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="path"><code className="tsd-tag">Readonly</code><span>path</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">path</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol"> = \[]</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Field names and array/map positions leading to the offending value</p>
        </div>

        <div className="aside tsd-sources">
          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/avro.ts#L44">src/avro.ts:44</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member tsd-is-inherited tsd-is-external">
        <h3 className="tsd-anchor-link" id="stack"><code className="tsd-tag">Optional</code><span>stack</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">stack</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span></div>

        <div className="aside tsd-sources">
          <p>Inherited from Error.stack</p>

          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/../kinetica-docs/mintlify/.typedoc/typedoc-0.28.20-ts-5.9.3/node_modules/typescript/lib/lib.es5.d.ts#L1078">../kinetica-docs/mintlify/.typedoc/typedoc-0.28.20-ts-5.9.3/node\_modules/typescript/lib/lib.es5.d.ts:1078</a></li>
          </ul>
        </div>
      </div>

      <div className="section tsd-panel tsd-member tsd-is-inherited tsd-is-external">
        <h3 className="tsd-anchor-link" id="stacktracelimit"><code className="tsd-tag">Static</code><span>stackTraceLimit</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">stackTraceLimit</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>The <code>Error.stackTraceLimit</code> property specifies the number of stack frames collected by a stack trace (whether generated by <code>new Error().stack</code> or <code>Error.captureStackTrace(obj)</code>).</p>
          <p>The default value is <code>10</code> but may be set to any valid JavaScript number. Changes will affect any stack trace captured <span className="em">after</span> the value has been changed.</p>
          <p>If set to a non-number value, or set to a negative number, stack traces will not capture any frames.</p>
        </div>

        <div className="aside tsd-sources">
          <p>Inherited from Error.stackTraceLimit</p>

          <ul>
            <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/node_modules/@types/node/globals.d.ts#L68">node\_modules/@types/node/globals.d.ts:68</a></li>
          </ul>
        </div>
      </div>
    </div>
  </div>

  <div className="details tsd-panel-group tsd-member-group tsd-accordion" open="">
    <div className="summary tsd-accordion-summary" data-key="section-Methods">
      <h2 className="tsd-anchor-link" id="methods-1">Methods</h2>
    </div>

    <div className="section">
      <div className="section tsd-panel tsd-member tsd-is-inherited tsd-is-external">
        <h3 className="tsd-anchor-link" id="capturestacktrace"><code className="tsd-tag">Static</code><span>captureStackTrace</span></h3>

        <ul className="tsd-signatures tsd-is-inherited tsd-is-external">
          <li className="tsd-is-inherited tsd-is-external">
            <div className="tsd-signature tsd-anchor-link" id="capturestacktrace-1"><span className="tsd-kind-call-signature">captureStackTrace</span><span className="tsd-signature-symbol">(</span><span className="tsd-kind-parameter">targetObject</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">object</span><span className="tsd-signature-symbol">,</span> <span className="tsd-kind-parameter">constructorOpt</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Function</span><span className="tsd-signature-symbol">)</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">void</span></div>

            <div className="tsd-description">
              <div className="tsd-comment tsd-typography">
                <p>Creates a <code>.stack</code> property on <code>targetObject</code>, which when accessed returns a string representing the location in the code at which <code>Error.captureStackTrace()</code> was called.</p>

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

                <p>The first line of the trace will be prefixed with <code>${"{"}myObject.name{"}"}: ${"{"}myObject.message{"}"}</code>.</p>
                <p>The optional <code>constructorOpt</code> argument accepts a function. If given, all frames above <code>constructorOpt</code>, including <code>constructorOpt</code>, will be omitted from the generated stack trace.</p>
                <p>The <code>constructorOpt</code> argument is useful for hiding implementation details of error generation from the user. For instance:</p>

                <div>
                  ```
                  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();
                  ```
                </div>
              </div>

              <div className="tsd-parameters">
                <h4 className="tsd-parameters-title">Parameters</h4>

                <ul className="tsd-parameter-list">
                  <li><span><span className="tsd-kind-parameter">targetObject</span>: <span className="tsd-signature-type">object</span></span></li>
                  <li><span><code className="tsd-tag">Optional</code><span className="tsd-kind-parameter">constructorOpt</span>: <span className="tsd-signature-type">Function</span></span></li>
                </ul>
              </div>

              <h4 className="tsd-returns-title">Returns <span className="tsd-signature-type">void</span></h4>

              <div className="aside tsd-sources">
                <p>Inherited from Error.captureStackTrace</p>

                <ul>
                  <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/node_modules/@types/node/globals.d.ts#L52">node\_modules/@types/node/globals.d.ts:52</a></li>
                </ul>
              </div>
            </div>
          </li>
        </ul>
      </div>

      <div className="section tsd-panel tsd-member tsd-is-inherited tsd-is-external">
        <h3 className="tsd-anchor-link" id="preparestacktrace"><code className="tsd-tag">Static</code><span>prepareStackTrace</span></h3>

        <ul className="tsd-signatures tsd-is-inherited tsd-is-external">
          <li className="tsd-is-inherited tsd-is-external">
            <div className="tsd-signature tsd-anchor-link" id="preparestacktrace-1"><span className="tsd-kind-call-signature">prepareStackTrace</span><span className="tsd-signature-symbol">(</span><span className="tsd-kind-parameter">err</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Error</span><span className="tsd-signature-symbol">,</span> <span className="tsd-kind-parameter">stackTraces</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">CallSite</span><span className="tsd-signature-symbol">\[]</span><span className="tsd-signature-symbol">)</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">any</span></div>

            <div className="tsd-description">
              <div className="tsd-parameters">
                <h4 className="tsd-parameters-title">Parameters</h4>

                <ul className="tsd-parameter-list">
                  <li><span><span className="tsd-kind-parameter">err</span>: <span className="tsd-signature-type">Error</span></span></li>
                  <li><span><span className="tsd-kind-parameter">stackTraces</span>: <span className="tsd-signature-type">CallSite</span><span className="tsd-signature-symbol">\[]</span></span></li>
                </ul>
              </div>

              <h4 className="tsd-returns-title">Returns <span className="tsd-signature-type">any</span></h4>

              <div className="tsd-comment tsd-typography">
                <div className="tsd-tag-see">
                  <h4 className="tsd-anchor-link" id="see">See</h4>
                  <p><a href="https://v8.dev/docs/stack-trace-api#customizing-stack-traces">[https://v8.dev/docs/stack-trace-api#customizing-stack-traces](https://v8.dev/docs/stack-trace-api#customizing-stack-traces)</a></p>
                </div>
              </div>

              <div className="aside tsd-sources">
                <p>Inherited from Error.prepareStackTrace</p>

                <ul>
                  <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/node_modules/@types/node/globals.d.ts#L56">node\_modules/@types/node/globals.d.ts:56</a></li>
                </ul>
              </div>
            </div>
          </li>
        </ul>
      </div>
    </div>
  </div>
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.