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

# HttpRequestOptions

> HttpRequestOptions — Kinetica Node.js API

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

  <div className="section tsd-panel tsd-comment">
    <div className="tsd-comment tsd-typography">
      <p>HTTP Transport abstraction for cross-platform support.</p>
    </div>
  </div>

  <div className="tsd-signature"><span className="tsd-signature-keyword">interface</span> <span className="tsd-kind-interface">HttpRequestOptions</span> <span className="tsd-signature-symbol">{"{"}</span><br /> <a className="tsd-kind-property" href="#body">body</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#bytes">bytes</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Uint8Array</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">ArrayBufferLike</span><span className="tsd-signature-symbol">></span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#headers">headers</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</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><br /> <a className="tsd-kind-property" href="#maxresponsebytes">maxResponseBytes</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#method">method</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">"GET"</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">"POST"</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#responsetype">responseType</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">"text"</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">"binary"</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#timeout">timeout</a><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span><span className="tsd-signature-symbol">;</span><br /> <a className="tsd-kind-property" href="#url">url</a><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">;</span><br /><span className="tsd-signature-symbol">{"}"}</span></div>

  <div className="aside tsd-sources">
    <ul>
      <li>Defined in <a href="https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/transport.ts#L5">src/transport.ts:5</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="properties">Properties</h3>
            <div className="tsd-index-list"><a href="#body" className="tsd-index-link"><span>body?</span></a> <a href="#bytes" className="tsd-index-link"><span>bytes?</span></a> <a href="#headers" className="tsd-index-link"><span>headers</span></a> <a href="#maxresponsebytes" className="tsd-index-link"><span>maxResponseBytes?</span></a> <a href="#method" className="tsd-index-link"><span>method</span></a> <a href="#responsetype" className="tsd-index-link"><span>responseType?</span></a> <a href="#timeout" className="tsd-index-link"><span>timeout?</span></a> <a href="#url" className="tsd-index-link"><span>url</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-Properties">
      <h2 className="tsd-anchor-link" id="properties-1">Properties</h2>
    </div>

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

        <div className="tsd-comment tsd-typography">
          <p>Request body, as text</p>
        </div>

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

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="bytes"><code className="tsd-tag">Optional</code><span>bytes</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">bytes</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">Uint8Array</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">ArrayBufferLike</span><span className="tsd-signature-symbol">></span></div>

        <div className="tsd-comment tsd-typography">
          <p>Request body, as bytes: set in place of <code>body</code> by a client constructed with <code>encoding: 'binary'</code>. A custom transport serving such a client must send these unchanged.</p>
        </div>

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

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="headers"><span>headers</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">headers</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">Record</span><span className="tsd-signature-symbol">\<</span><span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">,</span> <span className="tsd-signature-type">string</span><span className="tsd-signature-symbol">></span></div>

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

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="maxresponsebytes"><code className="tsd-tag">Optional</code><span>maxResponseBytes</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">maxResponseBytes</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span></div>

        <div className="tsd-comment tsd-typography">
          <p>Abandon the response once it passes this many bytes, rejecting with a ResponseTooLargeError. 0 or omitted means no ceiling.</p>
        </div>

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

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="method"><span>method</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">method</span><span className="tsd-signature-symbol">:</span> <span className="tsd-signature-type">"GET"</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">"POST"</span></div>

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

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="responsetype"><code className="tsd-tag">Optional</code><span>responseType</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">responseType</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">"text"</span> <span className="tsd-signature-symbol">|</span> <span className="tsd-signature-type">"binary"</span></div>

        <div className="tsd-comment tsd-typography">
          <p>'binary' also fills in <code>bytes</code> on the response, for responses that are not text -- WMS images, and the Avro a binary-encoding client receives. Decoding those as text would corrupt them.</p>
        </div>

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

      <div className="section tsd-panel tsd-member">
        <h3 className="tsd-anchor-link" id="timeout"><code className="tsd-tag">Optional</code><span>timeout</span></h3>
        <div className="tsd-signature"><span className="tsd-kind-property">timeout</span><span className="tsd-signature-symbol">?:</span> <span className="tsd-signature-type">number</span></div>

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

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

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


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