CINXE.COM

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>readArgs | @nevware21/ts-utils</title><meta name="description" content="Documentation for @nevware21/ts-utils"/><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">@nevware21/ts-utils</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">@nevware21/ts-utils</a></li><li><a href="readArgs.html">readArgs</a></li></ul><h1>Function readArgs</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="readArgs" class="tsd-anchor"></a><span class="tsd-kind-call-signature">read<wbr/>Args</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="readArgs.html#readArgs.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">theArgs</span>, <span class="tsd-kind-parameter">start</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">end</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a class="tsd-signature-type tsd-kind-type-parameter" href="readArgs.html#readArgs.T">T</a><span class="tsd-signature-symbol">[]</span><a href="#readArgs" 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>Read the arguments from the provided array, iterator / or generator function When processing an Iterable and a negative start or end is provided the entire iterator will be processed into an array before applying the start / end restrictions and when undefined or >= 0 any iterator will not be fully processed.</p> </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="readArgs.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</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">theArgs</span>: <span class="tsd-signature-type">ArrayLike</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="readArgs.html#readArgs.T">T</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="readArgs.html#readArgs.T">T</a><span class="tsd-signature-symbol">></span></span><div class="tsd-comment tsd-typography"><p>The arguments to process, may be ArrayLike or an Iterable</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">start</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Zero-based index at which to start extraction, converted to an integer.</p> <ul> <li>Negative index counts back from the end of the array or iteration</li> <li>if start < 0, start + (array.length || iterator.count) is used.</li> <li>If start < -array.length or start is omitted, 0 is used.</li> <li>If start >= array.length, nothing is extracted.</li> </ul> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">end</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Zero-based index at which to end extraction, converted to an integer. readArgs() extracts up to but not including end.</p> <ul> <li>Negative index counts back from the end of the array — if end < 0, end + array.length is used.</li> <li>If end < -array.length, 0 is used.</li> <li>If end >= array.length or end is omitted, array.length is used, causing all elements until the end to be extracted.</li> <li>If end is positioned before or at start after normalization, nothing is extracted.</li> </ul> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="readArgs.html#readArgs.T">T</a><span class="tsd-signature-symbol">[]</span></h4><p>A new array with the extracted elements</p> <div class="tsd-comment tsd-typography"><div class="tsd-tag-Example"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-0">function</span><span class="hl-1"> </span><span class="hl-3">myFunc</span><span class="hl-1"><</span><span class="hl-8">T</span><span class="hl-1">>(</span><span class="hl-2">firstArg</span><span class="hl-1">: </span><span class="hl-8">T</span><span class="hl-1">, ...</span><span class="hl-2">otherArgs</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-6">// Read all of the arguments</span><br/><span class="hl-1"> </span><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-2">allArgs</span><span class="hl-1"> = </span><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-0">arguments</span><span class="hl-1">);</span><br/><br/><span class="hl-1"> </span><span class="hl-6">// Get all of the arguments after the first</span><br/><span class="hl-1"> </span><span class="hl-0">let</span><span class="hl-1"> </span><span class="hl-2">optArgs</span><span class="hl-1"> = </span><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-0">arguments</span><span class="hl-1">, </span><span class="hl-4">1</span><span class="hl-1">);</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">myFunc</span><span class="hl-1">(</span><span class="hl-5">"Hello"</span><span class="hl-1">);</span><br/><span class="hl-3">myFunc</span><span class="hl-1">(</span><span class="hl-5">"Hello"</span><span class="hl-1">, </span><span class="hl-5">"Darkness"</span><span class="hl-1">, </span><span class="hl-5">"my"</span><span class="hl-1">, </span><span class="hl-5">"old"</span><span class="hl-1">, </span><span class="hl-5">"friend"</span><span class="hl-1">, </span><span class="hl-5">"."</span><span class="hl-1">);</span><br/><br/><span class="hl-0">function*</span><span class="hl-1"> </span><span class="hl-3">myGenerator</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"Hello"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"Darkness"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"my"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"old"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"friend"</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-0">function*</span><span class="hl-1"> </span><span class="hl-3">myGenerator2</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"I've"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"come"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"to"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"talk"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"with"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"you"</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><span class="hl-7">yield</span><span class="hl-1"> </span><span class="hl-5">"again"</span><span class="hl-1">;</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-3">myGenerator</span><span class="hl-1">());</span><br/><span class="hl-6">// [ "Hello", "Darkness", "my", "old", "friend"]);</span><br/><br/><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-3">myGenerator</span><span class="hl-1">(), </span><span class="hl-4">1</span><span class="hl-1">);</span><br/><span class="hl-6">// [ "Darkness", "my", "old", "friend"]);</span><br/><br/><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-3">myGenerator2</span><span class="hl-1">());</span><br/><span class="hl-6">// [ "I've", "come", "to", "talk", "with", "you", "again" ]);</span><br/><br/><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-3">myGenerator2</span><span class="hl-1">(), </span><span class="hl-4">0</span><span class="hl-1">, -</span><span class="hl-4">2</span><span class="hl-1">);</span><br/><span class="hl-6">// [ "I've", "come", "to", "talk", "with" ]);</span><br/><br/><span class="hl-3">readArgs</span><span class="hl-1">(</span><span class="hl-3">myGenerator2</span><span class="hl-1">(), -</span><span class="hl-4">3</span><span class="hl-1">, -</span><span class="hl-4">2</span><span class="hl-1">);</span><br/><span class="hl-6">// [ "with" ]);</span><br/> </code><button type="button">Copy</button></pre> </div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/nevware21/ts-utils/blob/main/lib/src/funcs/readArgs.ts#L87">lib/src/funcs/readArgs.ts:87</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><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>Protected</span></label></li><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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><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>@nevware21/ts-utils</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>