| <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>builderThroughAsyncIterable | 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.builderThroughAsyncIterable.html">builderThroughAsyncIterable</a></li></ul><h1>Function builderThroughAsyncIterable</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="builderThroughAsyncIterable" class="tsd-anchor"></a><span class="tsd-kind-call-signature">builder<wbr/>Through<wbr/>Async<wbr/>Iterable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.TNull">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">ThroughAsyncIterable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.TNull">TNull</a><span class="tsd-signature-symbol">></span><a href="#builderThroughAsyncIterable" 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>Transform an <code>AsyncIterable</code> of arbitrary JavaScript values into a |
| sequence of Arrow Vector<T> following the chunking semantics defined in |
| the supplied <code>options</code> argument.</p> |
| <p>This function returns a function that accepts an <code>AsyncIterable</code> of values to |
| transform. When called, this function returns an AsyncIterator of <code>Vector<T></code>.</p> |
| <p>The resulting <code>AsyncIterator<Vector<T>></code> yields Vectors based on the |
| <code>queueingStrategy</code> and <code>highWaterMark</code> specified in the <code>options</code> argument.</p> |
| <ul> |
| <li>If <code>queueingStrategy</code> is <code>"count"</code> (or omitted), The <code>AsyncIterator<Vector<T>></code> |
| will flush the underlying <code>Builder</code> (and yield a new <code>Vector<T></code>) once the |
| Builder's <code>length</code> reaches or exceeds the supplied <code>highWaterMark</code>.</li> |
| <li>If <code>queueingStrategy</code> is <code>"bytes"</code>, the <code>AsyncIterator<Vector<T>></code> will flush |
| the underlying <code>Builder</code> (and yield a new <code>Vector<T></code>) once its <code>byteLength</code> |
| reaches or exceeds the supplied <code>highWaterMark</code>.</li> |
| </ul> |
| </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="builderThroughAsyncIterable.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../classes/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="builderThroughAsyncIterable.TNull" 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">IterableBuilderOptions</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.TNull">TNull</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>An object of properties which determine the <code>Builder</code> to create and the chunking semantics to use.</p> |
| </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">ThroughAsyncIterable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.T">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="Arrow_dom.builderThroughAsyncIterable.html#builderThroughAsyncIterable.TNull">TNull</a><span class="tsd-signature-symbol">></span></h4><p>A function which accepts a JavaScript <code>AsyncIterable</code> of values |
| to write, and returns an <code>AsyncIterator</code> that yields Vectors |
| according to the chunking semantics defined in the <code>options</code> |
| argument.</p> |
| <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/6b278be178975fe7174b961a3bf33502acb79295/js/src/factories.ts#L256">factories.ts:256</a></li></ul></aside></li></ul></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></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> |
