| <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Builder | Apache Arrow - v17.0.0-SNAPSHOT</title><meta name="description" content="Documentation for Apache Arrow"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Apache Arrow - v17.0.0-SNAPSHOT</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Apache Arrow</a></li><li><a href="../modules/Arrow_dom.html">Arrow.dom</a></li><li><a href="Arrow_dom.Builder.html">Builder</a></li></ul><h1>Class Builder<T, TNull><code class="tsd-tag ts-flagAbstract">Abstract</code> </h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An abstract base class for types that construct Arrow Vectors from arbitrary JavaScript values.</p> |
| <p>A <code>Builder</code> is responsible for writing arbitrary JavaScript values |
| to ArrayBuffers and/or child Builders according to the Arrow specification |
| for each DataType, creating or resizing the underlying ArrayBuffers as necessary.</p> |
| <p>The <code>Builder</code> for each Arrow <code>DataType</code> handles converting and appending |
| values for a given <code>DataType</code>. The high-level <a href="../functions/Arrow_dom.makeBuilder.html" class="tsd-kind-function"><code>makeBuilder()</code></a> convenience |
| method creates the specific <code>Builder</code> subclass for the supplied <code>DataType</code>.</p> |
| <p>Once created, <code>Builder</code> instances support both appending values to the end |
| of the <code>Builder</code>, and random-access writes to specific indices |
| (<code>Builder.prototype.append(value)</code> is a convenience method for |
| <code>builder.set(builder.length, value)</code>). Appending or setting values beyond the |
| Builder's current length may cause the builder to grow its underlying buffers |
| or child Builders (if applicable) to accommodate the new values.</p> |
| <p>After enough values have been written to a <code>Builder</code>, <code>Builder.prototype.flush()</code> |
| will commit the values to the underlying ArrayBuffers (or child Builders). The |
| internal Builder state will be reset, and an instance of <code>Data<T></code> is returned. |
| Alternatively, <code>Builder.prototype.toVector()</code> will flush the <code>Builder</code> and return |
| an instance of <code>Vector<T></code> instead.</p> |
| <p>When there are no more values to write, use <code>Builder.prototype.finish()</code> to |
| finalize the <code>Builder</code>. This does not reset the internal state, so it is |
| necessary to call <code>Builder.prototype.flush()</code> or <code>toVector()</code> one last time |
| if there are still values queued to be flushed.</p> |
| <p>Note: calling <code>Builder.prototype.finish()</code> is required when using a <code>DictionaryBuilder</code>, |
| because this is when it flushes the values that have been enqueued in its internal |
| dictionary's <code>Builder</code>, and creates the <code>dictionaryVector</code> for the <code>Dictionary</code> <code>DataType</code>.</p> |
| </div><div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-0">import</span><span class="hl-1"> { </span><span class="hl-2">makeBuilder</span><span class="hl-1">, </span><span class="hl-2">Utf8</span><span class="hl-1"> } </span><span class="hl-0">from</span><span class="hl-1"> </span><span class="hl-3">'apache-arrow'</span><span class="hl-1">;</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">utf8Builder</span><span class="hl-1"> = </span><span class="hl-6">makeBuilder</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">type:</span><span class="hl-1"> </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">Utf8</span><span class="hl-1">(),</span><br/><span class="hl-1"> </span><span class="hl-2">nullValues:</span><span class="hl-1"> [</span><span class="hl-4">null</span><span class="hl-1">, </span><span class="hl-3">'n/a'</span><span class="hl-1">]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-2">utf8Builder</span><br/><span class="hl-1"> .</span><span class="hl-6">append</span><span class="hl-1">(</span><span class="hl-3">'hello'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-6">append</span><span class="hl-1">(</span><span class="hl-3">'n/a'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-6">append</span><span class="hl-1">(</span><span class="hl-3">'world'</span><span class="hl-1">)</span><br/><span class="hl-1"> .</span><span class="hl-6">append</span><span class="hl-1">(</span><span class="hl-4">null</span><span class="hl-1">);</span><br/><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">utf8Vector</span><span class="hl-1"> = </span><span class="hl-2">utf8Builder</span><span class="hl-1">.</span><span class="hl-6">finish</span><span class="hl-1">().</span><span class="hl-6">toVector</span><span class="hl-1">();</span><br/><br/><span class="hl-2">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-2">utf8Vector</span><span class="hl-1">.</span><span class="hl-6">toJSON</span><span class="hl-1">());</span><br/><span class="hl-7">// > ["hello", null, "world", null]</span> |
| </code><button>Copy</button></pre> |
| <h4>Typeparam</h4><p>T The <code>DataType</code> of this <code>Builder</code>.</p> |
| <h4>Typeparam</h4><p>TNull The type(s) of values which will be considered null-value sentinels.</p> |
| </div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="Arrow_dom.DataType.html" class="tsd-signature-type tsd-kind-class">DataType</a> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="TNull" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TNull</span> = <span class="tsd-signature-type">any</span></span></li></ul></section> <aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L102">builder.ts:102</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Arrow_dom.Builder.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a> |
| </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Arrow_dom.Builder.html#children" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>children</span></a> |
| <a href="Arrow_dom.Builder.html#finished" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>finished</span></a> |
| <a href="Arrow_dom.Builder.html#length" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>length</span></a> |
| <a href="Arrow_dom.Builder.html#nullValues" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>null<wbr/>Values?</span></a> |
| <a href="Arrow_dom.Builder.html#stride" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stride</span></a> |
| <a href="Arrow_dom.Builder.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a> |
| </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="Arrow_dom.Builder.html#ArrayType" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Array<wbr/>Type</span></a> |
| <a href="Arrow_dom.Builder.html#byteLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>byte<wbr/>Length</span></a> |
| <a href="Arrow_dom.Builder.html#nullBitmap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>null<wbr/>Bitmap</span></a> |
| <a href="Arrow_dom.Builder.html#nullCount" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>null<wbr/>Count</span></a> |
| <a href="Arrow_dom.Builder.html#numChildren" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>num<wbr/>Children</span></a> |
| <a href="Arrow_dom.Builder.html#reservedByteLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>reserved<wbr/>Byte<wbr/>Length</span></a> |
| <a href="Arrow_dom.Builder.html#reservedLength" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>reserved<wbr/>Length</span></a> |
| <a href="Arrow_dom.Builder.html#typeIds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>type<wbr/>Ids</span></a> |
| <a href="Arrow_dom.Builder.html#valueOffsets" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Offsets</span></a> |
| <a href="Arrow_dom.Builder.html#values" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>values</span></a> |
| </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Arrow_dom.Builder.html#addChild" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Child</span></a> |
| <a href="Arrow_dom.Builder.html#append" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>append</span></a> |
| <a href="Arrow_dom.Builder.html#clear" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear</span></a> |
| <a href="Arrow_dom.Builder.html#finish" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>finish</span></a> |
| <a href="Arrow_dom.Builder.html#flush" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>flush</span></a> |
| <a href="Arrow_dom.Builder.html#getChildAt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Child<wbr/>At</span></a> |
| <a href="Arrow_dom.Builder.html#isValid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Valid</span></a> |
| <a href="Arrow_dom.Builder.html#set" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a> |
| <a href="Arrow_dom.Builder.html#setValid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Valid</span></a> |
| <a href="Arrow_dom.Builder.html#setValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Value</span></a> |
| <a href="Arrow_dom.Builder.html#toVector" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Vector</span></a> |
| <a href="Arrow_dom.Builder.html#throughDOM" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>throughDOM</span></a> |
| <a href="Arrow_dom.Builder.html#throughNode" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>through<wbr/>Node</span></a> |
| </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Builder" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Builder</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span><a href="#constructor.new_Builder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Construct a builder with the given Arrow DataType with optional null values, |
| which will be interpreted as "null" when set or appended to the <code>Builder</code>.</p> |
| </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_Builder.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="Arrow_dom.DataType.html" class="tsd-signature-type tsd-kind-class">DataType</a><span class="tsd-signature-symbol"><</span><a href="../enums/Arrow_dom.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="constructor.new_Builder.TNull-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TNull</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">BuilderOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>A <code>BuilderOptions</code> object used to create this <code>Builder</code>.</p> |
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L120">builder.ts:120</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="children" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>children</span><a href="#children" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">children</span><span class="tsd-signature-symbol">:</span> <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L155">builder.ts:155</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="finished" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>finished</span><a href="#finished" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">finished</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div><div class="tsd-comment tsd-typography"><p>A boolean indicating whether <code>Builder.prototype.finish()</code> has been called on this <code>Builder</code>.</p> |
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L145">builder.ts:145</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="length" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>length</span><a href="#length" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">length</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div><div class="tsd-comment tsd-typography"><p>The number of values written to the <code>Builder</code> that haven't been flushed yet.</p> |
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L140">builder.ts:140</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="nullValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>null<wbr/>Values</span><a href="#nullValues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">null<wbr/>Values</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">readonly </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The list of null-value sentinels for this <code>Builder</code>. When one of these values |
| is written to the <code>Builder</code> (either via <code>Builder.prototype.set()</code> or <code>Builder.prototype.append()</code>), |
| a 1-bit is written to this Builder's underlying null BitmapBufferBuilder.</p> |
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L162">builder.ts:162</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="stride" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>stride</span><a href="#stride" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">stride</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of elements in the underlying values TypedArray that |
| represent a single logical element, determined by this Builder's |
| <code>DataType</code>. This is 1 for most types, but is larger when the <code>DataType</code> |
| is <code>Int64</code>, <code>Uint64</code>, <code>Decimal</code>, <code>DateMillisecond</code>, certain variants of |
| <code>Interval</code>, <code>Time</code>, or <code>Timestamp</code>, <code>FixedSizeBinary</code>, and <code>FixedSizeList</code>.</p> |
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L154">builder.ts:154</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a></div><div class="tsd-comment tsd-typography"><p>The Builder's <code>DataType</code> instance.</p> |
| </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L135">builder.ts:135</a></li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="ArrayType" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Array<wbr/>Type</span><a href="#ArrayType" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="ArrayType.ArrayType-1"><span class="tsd-signature-keyword">get</span> ArrayType<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L170">builder.ts:170</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="byteLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>byte<wbr/>Length</span><a href="#byteLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="byteLength.byteLength-1"><span class="tsd-signature-keyword">get</span> byteLength<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The aggregate length (in bytes) of the values that have been written.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L177">builder.ts:177</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="nullBitmap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>null<wbr/>Bitmap</span><a href="#nullBitmap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="nullBitmap.nullBitmap-1"><span class="tsd-signature-keyword">get</span> nullBitmap<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Uint8Array</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L213">builder.ts:213</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="nullCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>null<wbr/>Count</span><a href="#nullCount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="nullCount.nullCount-1"><span class="tsd-signature-keyword">get</span> nullCount<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L171">builder.ts:171</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="numChildren" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>num<wbr/>Children</span><a href="#numChildren" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="numChildren.numChildren-1"><span class="tsd-signature-keyword">get</span> numChildren<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L172">builder.ts:172</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reservedByteLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reserved<wbr/>Byte<wbr/>Length</span><a href="#reservedByteLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="reservedByteLength.reservedByteLength-1"><span class="tsd-signature-keyword">get</span> reservedByteLength<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The aggregate length (in bytes) that has been reserved to write new values.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L197">builder.ts:197</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reservedLength" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reserved<wbr/>Length</span><a href="#reservedLength" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="reservedLength.reservedLength-1"><span class="tsd-signature-keyword">get</span> reservedLength<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><p>The aggregate number of rows that have been reserved to write new values.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L190">builder.ts:190</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="typeIds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type<wbr/>Ids</span><a href="#typeIds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="typeIds.typeIds-1"><span class="tsd-signature-keyword">get</span> typeIds<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int8Array</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Int8Array</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L216">builder.ts:216</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="valueOffsets" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value<wbr/>Offsets</span><a href="#valueOffsets" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="valueOffsets.valueOffsets-1"><span class="tsd-signature-keyword">get</span> valueOffsets<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TOffsetArray"</span><span class="tsd-signature-symbol">]</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TOffsetArray"</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L207">builder.ts:207</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="values" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="values.values-1"><span class="tsd-signature-keyword">get</span> values<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TArray"</span><span class="tsd-signature-symbol">]</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TArray"</span><span class="tsd-signature-symbol">]</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L210">builder.ts:210</a></li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addChild" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Child</span><a href="#addChild" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addChild.addChild-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Child</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">child</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addChild.addChild-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">child</span>: <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></span></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = ...</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L264">builder.ts:264</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="append" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>append</span><a href="#append" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="append.append-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">append</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span><a href="#append.append-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Appends a value (or null) to this <code>Builder</code>. |
| This is equivalent to <code>builder.set(builder.length, value)</code>.</p> |
| </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TValue"</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>The value to append.</p> |
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L226">builder.ts:226</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="clear" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear</span><a href="#clear" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clear.clear-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span><a href="#clear.clear-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clear this Builder's internal state, including child Builders if applicable, and reset the length to 0.</p> |
| </div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span></h4><p>The cleared <code>Builder</code> instance.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L328">builder.ts:328</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="finish" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>finish</span><a href="#finish" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="finish.finish-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">finish</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span><a href="#finish.finish-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Finalize this <code>Builder</code>, and child builders if applicable.</p> |
| </div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span></h4><p>The finalized <code>Builder</code> instance.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L318">builder.ts:318</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="flush" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>flush</span><a href="#flush" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="flush.flush-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">flush</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Data.html" class="tsd-signature-type tsd-kind-class">Data</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#flush.flush-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Commit all the values that have been written to their underlying |
| ArrayBuffers, including any child Builders if applicable, and reset |
| the internal <code>Builder</code> state.</p> |
| </div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Data.html" class="tsd-signature-type tsd-kind-class">Data</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">></span></h4><p>A <code>Data<T></code> of the buffers and children representing the values written.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L284">builder.ts:284</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getChildAt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Child<wbr/>At</span><a href="#getChildAt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getChildAt.getChildAt-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Child<wbr/>At</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#getChildAt.getChildAt-1.R">R</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#getChildAt.getChildAt-1.R">R</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#getChildAt.getChildAt-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieve the child <code>Builder</code> at the supplied <code>index</code>, or null if no child |
| exists at that index.</p> |
| </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getChildAt.getChildAt-1.R" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">R</span><span class="tsd-signature-keyword"> extends </span><a href="Arrow_dom.DataType.html" class="tsd-signature-type tsd-kind-class">DataType</a><span class="tsd-signature-symbol"><</span><a href="../enums/Arrow_dom.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the child <code>Builder</code> to retrieve.</p> |
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#getChildAt.getChildAt-1.R">R</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>The child Builder at the supplied index or null.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L274">builder.ts:274</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="isValid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Valid</span><a href="#isValid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="isValid.isValid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">is<wbr/>Valid</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isValid.isValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Validates whether a value is valid (true), or null (false)</p> |
| </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TValue"</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>The value to compare against null the value representations</p> |
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L232">builder.ts:232</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="set" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set</span><a href="#set" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="set.set-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span><a href="#set.set-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Write a value (or null-value sentinel) at the supplied index. |
| If the value matches one of the null-value representations, a 1-bit is |
| written to the null <code>BitmapBufferBuilder</code>. Otherwise, a 0 is written to |
| the null <code>BitmapBufferBuilder</code>, and the value is passed to |
| <code>Builder.prototype.setValue()</code>.</p> |
| </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The index of the value to write.</p> |
| </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol"> | </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TValue"</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"><p>The value to write at the supplied index.</p> |
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Builder.html" class="tsd-signature-type tsd-kind-class">Builder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.TNull-1">TNull</a><span class="tsd-signature-symbol">></span></h4><p>The updated <code>Builder</code> instance.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L244">builder.ts:244</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setValid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Valid</span><a href="#setValid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setValid.setValid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Valid</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">valid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#setValid.setValid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">valid</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L258">builder.ts:258</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Value</span><a href="#setValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setValue.setValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Value</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">index</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setValue.setValue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Write a value to the underlying buffers at the supplied index, bypassing |
| the null-value check. This is a low-level method that</p> |
| </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">index</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"TValue"</span><span class="tsd-signature-symbol">]</span></span><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L257">builder.ts:257</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="toVector" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>Vector</span><a href="#toVector" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toVector.toVector-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>Vector</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Arrow_dom.Vector.html" class="tsd-signature-type tsd-kind-class">Vector</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">></span><a href="#toVector.toVector-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Flush the <code>Builder</code> and return a <code>Vector<T></code>.</p> |
| </div><h4 class="tsd-returns-title">Returns <a href="Arrow_dom.Vector.html" class="tsd-signature-type tsd-kind-class">Vector</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#constructor.new_Builder.T-1">T</a><span class="tsd-signature-symbol">></span></h4><p>A <code>Vector<T></code> of the flushed values.</p> |
| <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L168">builder.ts:168</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="throughDOM" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>throughDOM</span><a href="#throughDOM" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="throughDOM.throughDOM-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">throughDOM</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.T-2">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.TNull-2">TNull</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">BuilderTransform</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.T-2">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.TNull-2">TNull</a><span class="tsd-signature-symbol">></span><a href="#throughDOM.throughDOM-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="throughDOM.throughDOM-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="Arrow_dom.DataType.html" class="tsd-signature-type tsd-kind-class">DataType</a><span class="tsd-signature-symbol"><</span><a href="../enums/Arrow_dom.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="throughDOM.throughDOM-1.TNull-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TNull</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">BuilderTransformOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.T-2">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.TNull-2">TNull</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">BuilderTransform</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.T-2">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughDOM.throughDOM-1.TNull-2">TNull</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><h4>Nocollapse</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L111">builder.ts:111</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="throughNode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>through<wbr/>Node</span><a href="#throughNode" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="throughNode.throughNode-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">through<wbr/>Node</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughNode.throughNode-1.T-3">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughNode.throughNode-1.TNull-3">TNull</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Duplex</span><a href="#throughNode.throughNode-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="throughNode.throughNode-1.T-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="Arrow_dom.DataType.html" class="tsd-signature-type tsd-kind-class">DataType</a><span class="tsd-signature-symbol"><</span><a href="../enums/Arrow_dom.Type.html" class="tsd-signature-type tsd-kind-enum">Type</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span> = <span class="tsd-signature-type">any</span></span></li><li><span><a id="throughNode.throughNode-1.TNull-3" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TNull</span> = <span class="tsd-signature-type">any</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">BuilderDuplexOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughNode.throughNode-1.T-3">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.Builder.html#throughNode.throughNode-1.TNull-3">TNull</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Duplex</span></h4><div class="tsd-comment tsd-typography"><h4>Nocollapse</h4></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/apache/arrow/blob/14c54bbfb7d9305e79a2c2d016c34a655773e5cb/js/src/builder.ts#L106">builder.ts:106</a></li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#children" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>children</span></a><a href="#finished" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>finished</span></a><a href="#length" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>length</span></a><a href="#nullValues" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>null<wbr/>Values</span></a><a href="#stride" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>stride</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#ArrayType" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>Array<wbr/>Type</span></a><a href="#byteLength" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>byte<wbr/>Length</span></a><a href="#nullBitmap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>null<wbr/>Bitmap</span></a><a href="#nullCount" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>null<wbr/>Count</span></a><a href="#numChildren" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>num<wbr/>Children</span></a><a href="#reservedByteLength" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>reserved<wbr/>Byte<wbr/>Length</span></a><a href="#reservedLength" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>reserved<wbr/>Length</span></a><a href="#typeIds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>type<wbr/>Ids</span></a><a href="#valueOffsets" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Offsets</span></a><a href="#values" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>values</span></a><a href="#addChild" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Child</span></a><a href="#append" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>append</span></a><a href="#clear" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear</span></a><a href="#finish" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>finish</span></a><a href="#flush" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>flush</span></a><a href="#getChildAt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Child<wbr/>At</span></a><a href="#isValid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>is<wbr/>Valid</span></a><a href="#set" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set</span></a><a href="#setValid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Valid</span></a><a href="#setValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Value</span></a><a href="#toVector" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>Vector</span></a><a href="#throughDOM" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>throughDOM</span></a><a href="#throughNode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>through<wbr/>Node</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Apache Arrow - v17.0.0-SNAPSHOT</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html> |
